PHP rename() Function: Syntax, Parameters, Return Values, Examples, and Usage Notes

In PHP, the rename() function is used to rename files or directories, providing a straightforward way to change their names by specifying the source and target names.

Syntax

bool rename ( string $source , string $target )

Parameters

$source

: required, the name of the source file or directory. $target: required, the name of the destination file or directory.

Return Value

Returns TRUE on success and FALSE on failure.

Examples

Renaming a file:

<?php
$old_name = "old_file.txt";
$new_name = "new_file.txt";

if (rename($old_name, $new_name)) {
    echo "File renamed successfully!";
} else {
    echo "File rename failed!";
}
?>

This script attempts to rename old_file.txt to new_file.txt and outputs a success or failure message.

Renaming a directory:

<?php
$old_name = "old_directory";
$new_name = "new_directory";

if (rename($old_name, $new_name)) {
    echo "Directory renamed successfully!";
} else {
    echo "Directory rename failed!";
}
?>

The example shows how to rename a directory and report the result.

Notes

The rename() function may be limited by file system permissions; ensure you have sufficient rights. If the source file or directory does not exist, rename() returns FALSE.

Summary

The rename() function is a powerful PHP tool for renaming files or directories by specifying source and target names, and the provided examples demonstrate its usage in typical PHP projects.