← All built-ins / rename()

rename()

rename(string $haystack, string $needle): bool

Parameters

NameTypeDescription
$fromstringold path
$tostringnew path

Return value

true on success (also moves across directories).

Example

file_put_contents("/tmp/hphp_doc_rn1.txt", "x");
rename("/tmp/hphp_doc_rn1.txt", "/tmp/hphp_doc_rn2.txt");
var_dump(file_exists("/tmp/hphp_doc_rn1.txt"));
var_dump(file_exists("/tmp/hphp_doc_rn2.txt"));
unlink("/tmp/hphp_doc_rn2.txt");
bool(false)
bool(true)

See also

copy()unlink()