rename
(PHP 4, PHP 5, PHP 7)
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
oldnamemust match the wrapper used innewname. -
newname -
The new name.
Note: On Windows, if
newnamealready exists, it must be writable. Otherwise rename() fails and issuesE_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
- copy() - Copies file
- unlink() - Deletes a file
- move_uploaded_file() - Moves an uploaded file to a new location
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.rename.php