【PHP8.x】rename関数の使い方

rename関数は、ファイルやディレクトリの名前を変更したり、それらを別の場所へ移動したりするPHPの組み込み関数です。この関数を使用することで、既存のファイルやフォルダのパスや名前をプログラムから動的に変更できます。

基本的な使用方法としては、第一引数に現在存在しているファイルまたはディレクトリのパス（old_name）、第二引数に新しいファイルまたはディレクトリのパス（new_name）を指定します。たとえば、「original.txt」というファイルを「renamed.txt」に名前変更したり、「uploads/image.jpg」を「archives/image.jpg」という別のディレクトリへ移動したりすることが可能です。

処理が成功した場合は真（true）を、失敗した場合は偽（false）を返します。失敗する主な原因としては、指定されたold_nameのファイルやディレクトリが存在しない場合、新しいパスの親ディレクトリが存在しない場合、あるいはファイルシステムへの書き込み権限がない場合などが挙げられます。もしnew_nameで指定された場所にファイルがすでに存在する場合、通常は上書きされますが、new_nameが空でないディレクトリである場合は、エラーが発生することがあります。

この関数は、単に名前を変えるだけでなく、同じファイルシステム内であれば、ファイルやディレクトリを移動する用途にも利用できます。特に、ファイルのアップロード後の整理や、一時ファイルの移動、ユーザーが作成したコンテンツの管理などで頻繁に用いられます。そのため、ファイル操作を行う上で非常に重要な関数の一つです。使用する際は、エラーの可能性を考慮し、戻り値を適切に確認することをお勧めします。

<?php
rename("old_name.txt", "new_name.txt");
?>

string $from, string $to, ?resource $context = null

• string $from: 名前を変更したいファイルまたはディレクトリの現在のパス
• string $to: ファイルまたはディレクトリの新しいパス
• ?resource $context = null: コンテキストストリームを指定するリソース。省略可能

bool

rename関数は、ファイルやディレクトリの名前を変更するために使用されます。成功した場合はTRUEを、失敗した場合はFALSEを返します。