PHP rename() Function: Syntax, Parameters, Return Values, Usage Example, and Precautions

PHP's rename() function is used to rename or move a file or directory.

Syntax of rename()

rename(string $oldname, string $newname, resource $context = null): bool

Parameter description

$oldname

: Path of the existing file or directory. $newname: Desired new path for the file or directory. $context (optional): Context resource for additional options.

Return value

Returns true on success, false on failure.

Usage example

$oldname = '/path/to/old/file.txt';
$newname = '/path/to/new/file.txt';

if (rename($oldname, $newname)) {
    echo "File renamed successfully!";
} else {
    echo "File rename failed!";
}

Precautions

If the $newname path already exists, rename() will overwrite it.

The function can rename or move both files and directories.

Renaming across different file systems may fail.

It is recommended to verify that the source file or directory exists and that the script has sufficient permissions before calling rename().