<!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>Renames a file or a directory on the FTP server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-rawlist.html">ftp_rawlist</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-rmdir.html">ftp_rmdir</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ftp-rename" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_rename</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_rename</span> — <span class="dc-title">Renames a file or a directory on the FTP server</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-rename-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ftp_rename</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ftp_stream</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$oldname</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$newname</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>ftp_rename()</strong></span> renames a file or a directory on the FTP
server.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-rename-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">ftp_stream</code></em></span>
<dd>
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">oldname</code></em></span>
<dd>
<p class="para">
The old file/directory name.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">newname</code></em></span>
<dd>
<p class="para">
The new name.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-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.ftp-rename-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4303">
<p><strong>Example #1 <span class="function"><strong>ftp_rename()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$old_file </span><span style="color: #007700">= </span><span style="color: #DD0000">'somefile.txt.bak'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$new_file </span><span style="color: #007700">= </span><span style="color: #DD0000">'somefile.txt'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// set up basic connection<br /></span><span style="color: #0000BB">$conn_id </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$ftp_server</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// login with username and password<br /></span><span style="color: #0000BB">$login_result </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_login</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_name</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_pass</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// try to rename $old_file to $new_file<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">ftp_rename</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$old_file</span><span style="color: #007700">, </span><span style="color: #0000BB">$new_file</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"successfully renamed </span><span style="color: #0000BB">$old_file</span><span style="color: #DD0000"> to </span><span style="color: #0000BB">$new_file</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"There was a problem while renaming </span><span style="color: #0000BB">$old_file</span><span style="color: #DD0000"> to </span><span style="color: #0000BB">$new_file</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// close the connection<br /></span><span style="color: #0000BB">ftp_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-rawlist.html">ftp_rawlist</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-rmdir.html">ftp_rmdir</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
