PHP マニュアル: FTP サーバー上のファイルまたはディレクトリの名前を変更する

説明

bool ftp_rename(FTP\Connection $ftp, string $from, string $to)

ftp_rename は FTP サーバー上のファイルやディレクトリの名前を変更します。

パラメータ

ftp: FTP\Connection クラスのインスタンス
from: 現在のファイル/ディレクトリの名前。
to: 新しい名前。

戻り値

成功した場合に true を、失敗した場合に false を返します。失敗したとき(存在しないファイルを変更しようとしたときなど) は、 E_WARNING レベルのエラーが発生します。

変更履歴

バージョン	説明
8.1.0	引数 `ftp` は、FTP\Connection のインスタンスを期待するようになりました。これより前のバージョンでは、resource を期待していました。

例

例1 ftp_rename の例

<?php
$old_file = 'somefile.txt.bak';
$new_file = 'somefile.txt';

// 接続を確立する
$ftp = ftp_connect($ftp_server);

// ユーザー名とパスワードでログインする
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

// $old_file を $new_file に変更することを試みる
if (ftp_rename($ftp, $old_file, $new_file)) {
    echo "Successfully renamed $old_file to $new_file\n";
} else {
    echo "There was a problem while renaming $old_file to $new_file\n";
}

// 接続を閉じる
ftp_close($ftp);
?>