rename

(PHP 3, PHP 4, PHP 5)

rename -- Renames a file or directory

Description

bool rename ( string oldname, string newname [, resource context] )

Attempts to rename oldname to newname.

Returns TRUE on success or FALSE on failure.

Example 1. Example with rename()

<?php
rename
("/tmp/tmp_file.txt", "/home/user/login/docs/my_file.txt");
?>

Note: Prior to PHP 4.3.3, rename() could not rename files across partitions on *nix based systems.

Note: As of PHP 5.0.0 rename() can also be used with some URL wrappers. Refer to Appendix N for a listing of which wrappers support rename().

Note: The wrapper used in oldname MUST match the wrapper used in newname.

Note: Context support was added with PHP 5.0.0. For a description of contexts, refer to Reference CLX, Stream Functions.

See also copy(), unlink(), and move_uploaded_file().