rename
PHP function
Edit on GitHub ✎
(PHP 4, PHP 5, PHP 7, PHP 8)
Renames a file or directory
Description
rename(string $from, string $to, resource|null $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
fromThe old name.
NoteThe wrapper used in
frommust match the wrapper used into.toThe new name.
NoteOn Windows, if
toalready exists, it must be writable. Otherwiserename()fails and issuesE_WARNING.contextContext-support
Return Values
Success
Examples
Example with rename()
php
<?php
rename("/tmp/tmp_file.txt", "/home/user/login/docs/my_file.txt");
?>