streamWrapper::rename

(PHP 5, PHP 7, PHP 8)

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

説明

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

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

path_frompath_to に変更します。

注意:

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

パラメータ

path_from

現在のファイルの URL。

path_to

path_from の変更後の URL。

戻り値

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

エラー / 例外

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

注意

注意:

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

参考

  • rename() - ファイルをリネームする

関連キーワード:  名前, ディレクトリ, path, streamWrapper, ファイル, rename, from, 変更, メソッド, 注意