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

disk_total_space関数は、指定されたディレクトリが存在するファイルシステムの総容量を取得する関数です。この関数は、サーバーやシステムのリソースを管理する際などに、ディスクの物理的な最大容量を確認するために利用されます。

引数には、容量を調べたいディレクトリのパスを文字列型で指定します。例えば、Linux環境であれば/（ルートディレクトリ）、Windows環境であればC:/のように指定することで、そのパスが属するファイルシステムの総容量が得られます。このパスは実際に存在するディレクトリである必要があり、存在しないパスを指定した場合はエラーとなることがあります。

関数が成功すると、指定されたパスが属するファイルシステムの合計容量がバイト単位の整数値で返されます。この戻り値は非常に大きな数値になることが多いため、表示する際にはギガバイト（GB）やテラバイト（TB）といった、人間が読みやすい単位に変換することが一般的です。もし関数が失敗した場合、例えば指定されたディレクトリが存在しない、またはアクセス権がないなどの理由で情報を取得できない場合には、falseが返されます。そのため、関数がfalseを返さないかを確認し、適切なエラーハンドリングを行うことが重要です。

この関数はPHP 8以降で利用可能です。システムのリソース状況を監視したり、ユーザーがファイルをアップロードする前に利用可能なディスク容量をチェックしたりするなど、様々なシステム管理の場面で活用されます。disk_free_space関数と組み合わせることで、総容量と現在の空き容量の両方を把握することが可能になります。

<?php
$directory_path = '/';
$total_disk_space_bytes = disk_total_space($directory_path);
?>

string $directory

• string $directory: サイズを取得したいディレクトリのパスを指定する文字列

int|false

指定されたパスのディスク全体の容量をバイト単位の整数で返します。エラーが発生した場合は false を返します。