php8.5
Home/ Manual/ stream / streamwrapper/ streamWrapper::rename

streamWrapper::rename

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Renames a file or directory

Description

streamWrapper::rename(string $path_from, string $path_to): bool

This method is called in response to rename().

Should attempt to rename path_from to path_to

Note

In order for the appropriate error message to be returned this method should not be defined if the wrapper does not support renaming files.

Parameters

path_from

The URL to the current file.

path_to

The URL which the path_from should be renamed to.

Return Values

Success

Errors/Exceptions Warning

Notes Context

See Also

Source: reference/stream/streamwrapper/rename.xml · from the official PHP manual (php/doc-en)