PHP 檔案系統 rename() 函式



PHP 檔案系統rename()函式用於重新命名檔案或目錄,此函式成功時返回true,失敗時返回false。

此函式可以嘗試將oldname重新命名為newname,必要時可在目錄之間移動它。如果重新命名檔案且newname已存在,則可以覆蓋它。如果重新命名目錄且newname已存在,則此函式會發出警告。

語法

以下是PHP檔案系統rename()函式的語法:

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

引數

以下是rename()函式的必需和可選引數:

序號 引數及說明
1

$oldname (必需)

它是檔案的舊名稱。

2

$newname (必需)

它是檔案的舊名稱

3

$context (可選)

它設定檔案控制代碼的上下文。上下文是一組可能影響流行為的因素。

返回值

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中重新命名檔案和目錄非常有用。

php_function_reference.htm
廣告