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

diskfreespace関数は、指定したディレクトリが存在するファイルシステムの、利用可能なディスクの空き容量を取得する関数です。この関数は、アプリケーションがファイルを保存する前に十分なディスクスペースがあるかを確認したり、システムのリソース状況を監視したりする際に非常に役立ちます。

この関数を使用する際は、空き容量を調べたいディレクトリのパスを文字列として引数に指定します。例えば、ウェブアプリケーションのログファイルを保存するディレクトリや、一時ファイルを格納するディレクトリのパスなどです。関数が正常に実行されると、指定されたディレクトリが含まれるファイルシステム全体の利用可能な空き容量が、バイト単位の浮動小数点数（float）として返されます。これにより、ギガバイトやテラバイトといった大容量のディスクスペースでも正確な値を取得できます。

もし、指定したディレクトリが見つからない、またはアクセス権がないなどの理由でエラーが発生した場合は、この関数はfalseを返します。そのため、戻り値を常に確認し、エラーハンドリングを行うことが重要です。特に、ネットワークドライブのような特定の環境では、OSが報告する空き容量が実際の値と異なる場合があるため、利用する際は注意が必要です。PHP 8の環境では、戻り値が常に浮動小数点数であることを念頭に置いてプログラミングしてください。

diskfreespace(string $directory);

string $directory

• string $directory: 空き容量を確認したいディレクトリのパスを指定する文字列

int|false

指定されたディレクトリの空き容量をバイト単位で返します。エラーが発生した場合は false を返します。