RENAME(3) 1 RENAME(3)
rename - Renames a file or directory
SYNOPSIS
bool rename (string $oldname, string $newname, [resource $context])
DESCRIPTION
Attempts to rename $oldname to $newname, moving it between directories if necessary. If $newname exists, it will be overwritten.
PARAMETERS
o $oldname
-
Note
The old name. The wrapper used in $oldname must match the wrapper used in $newname.
o $newname
- The new name.
o $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.
CHANGELOG
+--------+---------------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------------------------------+
| 5.3.1 | |
| | |
| | rename(3) can now rename files across drives in |
| | Windows. |
| | |
| 5.0.0 | |
| | |
| | rename(3) can now also be used with some URL |
| | wrappers. Refer to "Supported Protocols and Wrap- |
| | pers" for a listing of which wrappers support |
| | rename(3). |
| | |
| 4.3.3 | |
| | |
| | rename(3) may now be able to rename files across |
| | partitions on *nix based systems, provided the |
| | appropriate permissions are held. Warnings may be |
| | generated if the destination filesystem doesn't |
| | permit chown() or chmod() system calls to be made |
| | on files -- for example, if the destination |
| | filesystem is a FAT filesystem. |
| | |
+--------+---------------------------------------------------+
EXAMPLES
Example #1
Example with rename(3)
<?php
rename("/tmp/tmp_file.txt", "/home/user/login/docs/my_file.txt");
?>
SEE ALSO
copy(3), unlink(3), move_uploaded_file(3).
PHP Documentation Group RENAME(3)
