streamWrapper::rename

(PHP 5, PHP 7, PHP 8)

streamWrapper::renameRenames a file or directory

说明

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

注意:

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

参数

path_from

The URL to the current file.

path_to

The URL which the path_from should be renamed to.

返回值

成功时返回 true, 或者在失败时返回 false

错误/异常

调用此方法失败将给出 E_WARNING(未实现)。

注释

注意:

当合法的上下文传递给调用函数时,属性 streamWrapper::$context 会被改变。

参见

  • rename() - 重命名一个文件或目录