streamWrapper::rename()

(PHP 5, PHP 7)

Renames a file or directory

说明

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

This method is called in response torename().

Should attempt to rename$path_fromto$path_to

Note:

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

参数

$path_from

The URL to the current file.

$path_to

The URL which the$path_fromshould be renamed to.

返回值

成功时返回TRUE，或者在失败时返回FALSE。

错误／异常

调用此方法失败将给出E_WARNING（未实现）。

注释

Note:

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

参见

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