streamWrapper::rename

(PHP 5, PHP 7, PHP 8)

streamWrapper::rename — ファイルあるいはディレクトリの名前を変える

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

このメソッドは、rename() に対応してコールされます。

path_from を path_to に変更します。

注意:
適切なエラーメッセージを返すためには、ラッパーがファイル名の変更に対応していない場合にはこのメソッドを定義しては いけません。

成功した場合に true を、失敗した場合に false を返します。

このメソッドのコールに (未実装などの理由で) 失敗した場合、 E_WARNING を発行します。

注意:
有効なコンテキストがコール元関数に渡された場合に streamWrapper::$context プロパティが更新されます。