array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'streamwrapper.rename.php', 1 => 'streamWrapper::rename', 2 => 'Renames a file or directory', ), 'up' => array ( 0 => 'class.streamwrapper.php', 1 => 'streamWrapper', ), 'prev' => array ( 0 => 'streamwrapper.mkdir.php', 1 => 'streamWrapper::mkdir', ), 'next' => array ( 0 => 'streamwrapper.rmdir.php', 1 => 'streamWrapper::rmdir', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/stream/streamwrapper/rename.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

streamWrapper::rename

(PHP 5, PHP 7, PHP 8)

streamWrapper::rename — Renames a file or directory

Description

public 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

Returns true on success or false on failure.

Errors/Exceptions

Emits E_WARNING if call to this method fails (i.e. not implemented).

Notes

Note:

The streamWrapper::$context property is updated if a valid context is passed to the caller function.

See Also