【PHP8.x】filesize関数の使い方
filesize関数は、指定されたファイルのサイズをバイト単位で取得する関数です。この関数は、引数としてファイル名を表す文字列を一つ受け取ります。ファイル名には、対象ファイルの相対パスまたは絶対パスを指定できます。
関数が正常に実行された場合、ファイルのサイズが整数値として返されます。この値は、ファイルのデータを構成する最小単位であるバイトの総数を示しています。例えば、1024バイトは1キロバイトに相当します。
しかし、いくつかの状況で関数は失敗し、false
を返すことがあります。これには、指定されたファイルが存在しない場合、PHPがファイルへの読み取り権限を持っていない場合、またはファイルではなくディレクトリのパスを指定した場合などが含まれます。これらのエラーが発生した場合、PHPは警告メッセージも出力しますので、関数がfalse
を返した際には、適切なエラー処理を行うことが重要です。
filesize関数は、ローカルファイルシステム上のファイルにのみ適用される点に注意してください。例えば、HTTPやFTPなどのストリームラッパーを介したリモートファイルのサイズを取得しようとしても、期待通りに動作しないことがあります。また、ファイルサイズがPHPの整数型の最大値を超えるような非常に大きなファイルの場合、特に32ビットシステムでは正確な値が取得できない可能性があるため、この点も考慮に入れる必要があります。この関数は、ファイルのアップロード制限のチェックや、ディスク使用量の計算、ファイル処理の事前確認など、ファイルの基本的な情報を取得する上で広く活用されます。
基本的な使い方
構文(syntax)
<?php
$fileSize = filesize('path/to/your/file.txt');
?>
引数(parameters)
string $filename
- string $filename: サイズを取得したいファイルの名前を指定する文字列
戻り値(return)
int|false
指定されたファイルサイズをバイト単位の整数で返します。ファイルが存在しない、あるいはアクセスできない場合は false
を返します。