<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Rename a remote file</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-sftp-realpath.html">ssh2_sftp_realpath</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ssh2-sftp-rmdir.html">ssh2_sftp_rmdir</a></div> <div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.ssh2-sftp-rename" class="refentry"> <div class="refnamediv"> <h1 class="refname">ssh2_sftp_rename</h1> <p class="verinfo">(PECL ssh2 >= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_sftp_rename</span> — <span class="dc-title">Rename a remote file</span></p> </div> <div class="refsect1 description" id="refsect1-function.ssh2-sftp-rename-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>ssh2_sftp_rename</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$sftp</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$from</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$to</code></span> )</div> <p class="para rdfs-comment"> Renames a file on the remote filesystem. </p> </div> <div class="refsect1 parameters" id="refsect1-function.ssh2-sftp-rename-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">sftp</code></em></span> <dd> <p class="para"> An SSH2 SFTP resource opened by <span class="function"><a href="function.ssh2-sftp.html" class="function">ssh2_sftp()</a></span>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">from</code></em></span> <dd> <p class="para"> The current file that is being renamed. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">to</code></em></span> <dd> <p class="para"> The new file name that replaces <em><code class="parameter">from</code></em>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ssh2-sftp-rename-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.ssh2-sftp-rename-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4624"> <p><strong>Example #1 Renaming a file via sftp</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$connection </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'shell.example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ssh2_auth_password</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'password'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$sftp </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_sftp</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">ssh2_sftp_rename</span><span style="color: #007700">(</span><span style="color: #0000BB">$sftp</span><span style="color: #007700">, </span><span style="color: #DD0000">'/home/username/oldname'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/home/username/newname'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.ssh2-sftp-rename-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.rename.html" class="function" rel="rdfs-seeAlso">rename()</a> - Renames a file or directory</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-sftp-realpath.html">ssh2_sftp_realpath</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ssh2-sftp-rmdir.html">ssh2_sftp_rmdir</a></div> <div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>