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

作成日: 更新日:

touch関数は、指定されたファイルの最終アクセス時刻および最終変更時刻を更新する関数です。この関数は、主にファイルのタイムスタンプを現在の時刻に設定するために使用されます。もし指定されたファイルが存在しない場合、touch関数は、そのパスに新しい空のファイルを自動的に作成します。

この関数には、操作対象のファイルパスを文字列で指定する必須の引数 $filename があります。オプションとして、2つの整数引数を指定できます。2番目の引数 $time は、ファイルの最終変更時刻をUNIXタイムスタンプ形式で指定します。この引数を省略した場合、現在のシステムの時刻が使用されます。3番目の引数 $atime は、ファイルの最終アクセス時刻をUNIXタイムスタンプ形式で指定します。これも省略された場合、現在のシステムの時刻が使用されます。

touch関数は、処理が成功した場合には true を返し、ファイルが存在しない状態で新しいファイルの作成に失敗した場合や、ファイルが存在するがタイムスタンプの更新に失敗した場合など、何らかのエラーが発生した場合には false を返します。ファイルに対する書き込み権限や、新しいファイルを作成するためのディレクトリへの書き込み権限が必要であることに留意してください。システムエンジニアにとって、ファイルのライフサイクル管理やバックアップ処理などで、ファイルのタイムスタンプを操作する必要がある場合に役立ちます。

基本的な使い方

構文(syntax)

touch(string $filename, ?int $mtime = null, ?int $atime = null): bool

引数(parameters)

string $filename, ?int $mtime = null, ?int $atime = null

  • string $filename: タイムスタンプを更新するファイルの名前を指定します。
  • ?int $mtime = null: ファイルの最終更新時刻を指定します。指定しない場合は、現在の時刻が使用されます。
  • ?int $atime = null: ファイルの最終アクセス時刻を指定します。指定しない場合は、現在の時刻が使用されます。

戻り値(return)

bool

指定されたファイルへのタッチ操作(更新時刻の変更または新規作成)が成功した場合はtrue、失敗した場合はfalseを返します。