rename

(PHP 4, PHP 5, PHP 7, PHP 8)

rename — Renames a file or directory

Description

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

Attempts to rename oldname to newname, moving it between directories if necessary. If renaming a file and newname exists, it will be overwritten. If renaming a directory and newname exists, this function will emit a warning.

Parameters

oldname

The old name.

Note:

The wrapper used in oldname must match the wrapper used in newname.

newname

The new name.

Note: On Windows, if newname already exists, it must be writable. Otherwise rename() fails and issues E_WARNING.

context

Note: Context support was added with PHP 5.0.0. For a description of contexts, refer to Streams.

Return Values

Returns true on success or false on failure.

Examples

Example #1 Example with rename()

<?php
rename("/tmp/tmp_file.txt", "/home/user/login/docs/my_file.txt");
?>

See Also