PHP 文件系统 rename() 函数

---

---

PHP 文件系统rename()函数用于重命名文件或目录，此函数成功时返回true，失败时返回false。

此函数可以尝试将oldname重命名为newname，必要时可在目录之间移动它。如果重命名文件且newname已存在，则可以覆盖它。如果重命名目录且newname已存在，则此函数会发出警告。

语法

以下是PHP文件系统rename()函数的语法：

bool rename ( string $oldname , string $newname [, resource $context ] )

参数

以下是rename()函数的必需和可选参数：

返回值

rename()函数成功时返回TRUE，失败时返回FALSE。

PHP 版本

rename()函数首次作为PHP 4核心的一部分引入，并与PHP 5、PHP 7和PHP 8良好兼容。

示例

这是一个基本示例，演示如何使用PHP文件系统rename()函数更改给定文件的名称。

<?php
   rename("/PhpProject/sample.txt", "/PhpProject/php/sample1.txt");
   echo "The File is Renamed Successfully.";
?>

输出

以下是以下代码的结果：

The File is Renamed Successfully.

示例

这是一个另一个示例，演示了如何使用rename()函数在处理错误时将文件名更改为新名称。

<?php
   $old_file = 'oldfile.txt';
   $new_file = 'newfile.txt';

   if (rename($old_file, $new_file)) {
      echo "File renamed successfully.";
   } else {
      echo "Error renaming file.";
   }

输出

这将产生以下结果：

File renamed successfully.

示例

这是一个示例，演示了如何通过重命名目录名称来使用rename()函数。

<?php
   //Create a new directory inside the current directory
   mkdir("PhpProject");

   $oldname = 'PhpProject';
   $newname = 'MyPhpProjects';

   //Rename the directory
   $success = rename($oldname, $newname);

   if($success) {
      echo "$oldname is renamed to $newname.\n";
   } else {
      echo "$oldname can not be renamed to $newname.\n";
   }
?> 

输出

这将生成以下输出：

PhpProject is renamed to MyPhpProjects.

示例

这是一个示例，演示了如何使用rename()函数通过更改文件的名称将文件移动到不同的目录。

<?php
// Current file path and name
$old_path = '/Users/Desktop/PHP/PhpProjects/myfile.txt';

// New directory path and new file name
$new_directory = '/Users/Desktop';
$new_filename = 'newfile.txt';

// Combine new directory path and new filename
$new_path = $new_directory. '/' . $new_filename;

// Attempt to rename (move) the file
if (rename($old_path, $new_path)) {
   echo "File moved successfully to $new_path.";
} else {
   echo "Error moving file.";
}
?> 

输出

这将导致以下输出：

File moved successfully to /Users/Desktop/newfile.txt

重要提示

使用rename()函数时，请记住以下几点：

• 在Windows上，如果存在，则必须可读。否则，rename()失败并返回E_WARNING。
• oldname中使用的包装器必须与newname中使用的包装器匹配。

总结

rename()方法是一个内置函数，用于更改给定文件的名称。它对于在PHP中重命名文件和目录非常有用。