rename

PHP 4, PHP 5, PHP 7, PHP 8
rename - Renames a file or directory
Manual
Code Examples

rename( string$from, string$to, [resource|null$context = null] ): bool

Attempts to rename from to to, moving it between directories if necessary. If renaming a file and to exists, it will be overwritten. If renaming a directory and to exists, this function will emit a warning.

Parameters

from

The old name.

Note:

The wrapper used in from must match the wrapper used in to.

to

The new name.

Note:

On Windows, if to already exists, it must be writable. Otherwise rename fails and issues E_WARNING.

context

A context stream resource.

Return Values

Returns true on success or false on failure.

Related Functions

Example of rename

Show all examples for rename

PHP Version: