<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.filesystem.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.rename.php',
    1 => 'rename',
    2 => '重命名一个文件或目录',
  ),
  'up' => 
  array (
    0 => 'ref.filesystem.php',
    1 => '文件系统函数',
  ),
  'prev' => 
  array (
    0 => 'function.realpath-cache-size.php',
    1 => 'realpath_cache_size',
  ),
  'next' => 
  array (
    0 => 'function.rewind.php',
    1 => 'rewind',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/filesystem/functions/rename.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.rename" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">rename</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">rename</span> &mdash; <span class="dc-title">重命名一个文件或目录</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.rename-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>rename</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$from</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$to</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span></span> <code class="parameter">$context</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   尝试把 <code class="parameter">from</code> 重命名为
   <code class="parameter">to</code>，必要时会在不同目录间移动。
   如果重命名文件时 <code class="parameter">to</code> 已经存在，将会覆盖掉它。
   如果重命名文件夹时
   <code class="parameter">to</code> 已经存在，本函数将导致一个警告。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.rename-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">from</code></dt>
     <dd>
      <p class="para">
       原名
      </p>
      <blockquote class="note"><p><strong class="note">注意</strong>: 
       <p class="para">
        用于 <code class="parameter">from</code> 中的封装协议<em>必须</em>和用于
        <code class="parameter">to</code> 中的相匹配。
       </p>
      </p></blockquote>
     </dd>
    
    
     <dt><code class="parameter">to</code></dt>
     <dd>
      <p class="para">
       新的名字。
       <blockquote class="note"><p><strong class="note">注意</strong>: 
        <span class="simpara">
         在 Windows 上，如果 <code class="parameter">to</code> 已经存在，它必须是可写的。
         否则 <span class="function"><strong>rename()</strong></span> 将失败，并导致 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>。
        </span>
       </p></blockquote>
      </p>
     </dd>
    
    
     <dt><code class="parameter">context</code></dt>
     <dd>
      <p class="para"><a href="stream.contexts.php" class="link">上下文流（context stream）</a>
<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>。</p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.rename-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>， 或者在失败时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.rename-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1  <span class="function"><strong>rename()</strong></span> 例子</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />rename</span><span style="color: #007700">(</span><span style="color: #DD0000">"/tmp/tmp_file.txt"</span><span style="color: #007700">, </span><span style="color: #DD0000">"/home/user/login/docs/my_file.txt"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.rename-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.copy.php" class="function" rel="rdfs-seeAlso">copy()</a> - 拷贝文件</span></li>
    <li><span class="function"><a href="function.unlink.php" class="function" rel="rdfs-seeAlso">unlink()</a> - 删除文件</span></li>
    <li><span class="function"><a href="function.move-uploaded-file.php" class="function" rel="rdfs-seeAlso">move_uploaded_file()</a> - 将上传的文件移动到新位置</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>