rename

関数の概要

PHPの rename 関数は、ファイルやディレクトリの名前を変更するために使われます。この関数を使うことで、簡単にファイルの移動やリネームが可能です。特にWordPressの開発や運用の際に、アップロードファイルの整理やテンプレートファイルのリネームなど実務で役立ちます。

パラメータの説明

  • oldname：変更前のファイルまたはディレクトリのパス（文字列）。
  • newname：変更後のファイルまたはディレクトリの新しいパス（文字列）。

戻り値

rename 関数は、リネームが成功した場合に true を返し、失敗した場合は false を返します。失敗する理由としては、指定したファイルが存在しない、書き込み権限がない、または新しい名前が無効である場合などがあります。

使用例

基本的な使い方

<?php
$old = 'oldfile.txt';
$new = 'newfile.txt';

if(rename($old, $new)) {
    echo 'ファイル名を変更しました。';
} else {
    echo 'ファイル名の変更に失敗しました。';
}
?>

この例では、カレントディレクトリ内の「oldfile.txt」を「newfile.txt」に名前を変更しています。成功すればメッセージが表示されます。

ディレクトリ名の変更

<?php
$oldDir = 'old_directory';
$newDir = 'new_directory';

if(rename($oldDir, $newDir)) {
    echo 'ディレクトリ名を変更しました。';
} else {
    echo 'ディレクトリ名の変更に失敗しました。';
}
?>

ファイルだけでなく、ディレクトリ名の変更も同様に行えます。移動先に同名のディレクトリがある場合は失敗しますので注意が必要です。

ファイルの移動とリネームを同時に行う

<?php
$oldPath = 'uploads/image.jpg';
$newPath = 'backup/image_backup.jpg';

if(rename($oldPath, $newPath)) {
    echo 'ファイルを移動して名前を変更しました。';
} else {
    echo 'ファイル移動または名前変更に失敗しました。';
}
?>

ファイルのパスを変えることで、ファイルの移動とリネームを同時に行うことができます。WordPressのカスタムアップロード管理などで便利です。

関連する関数

  • unlink：ファイルを削除する
  • copy：ファイルをコピーする
  • dirname：ファイルパスのディレクトリ名を取得する
  • is_writable：ファイルやディレクトリが書き込み可能か確認する

まとめ

rename 関数はPHPでファイルやディレクトリの名前を変更・移動するための基本的かつ重要な関数です。使い方もシンプルで、ファイル管理の処理をスムーズに行えます。権限設定やファイルの存在確認に注意しながら活用すると、WordPressの開発や運用において非常に便利です。

スポンサーリンク