Php/docs/function.rename
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
oldnameThe old name.
Note:
The wrapper used in
oldnamemust match the wrapper used innewname.newnameThe new name.
Note:
On Windows, if
newnamealready exists, it must be writable. Otherwise rename() fails and issuesE_WARNING.contextNote: Context support was added
with PHP 5.0.0. For a description of
contexts, refer to
Return Values
Returns TRUE on success or FALSE on failure.
Examples
Example #1 Example with rename()
<?phprename("/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
