rename
(PHP 4, PHP 5, PHP 7, PHP 8)
rename — Renames a file or directory
Description
$from, string $to, ?resource $context = null): bool
Attempts to rename from to
to, moving it between directories if necessary.
If renaming a file and to exists,
it will be overwritten. If renaming a directory and
to exists,
this function will emit a warning.
Parameters
-
from -
The old name.
Note:
The wrapper used in
frommust match the wrapper used into. -
to -
The new name.
Note: On Windows, if
toalready exists, it must be writable. Otherwise rename() fails and issuesE_WARNING. -
context -
A context stream resource.
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
- copy() - Copies file
- unlink() - Deletes a file
- move_uploaded_file() - Moves an uploaded file to a new location

