PHPのdisk_total_space()関数とは？使い方とサンプルコードを解説

PHPのdisk_total_space()関数は、指定したディレクトリが属するファイルシステムの総容量を取得するための組み込み関数です。戻り値はバイト単位の数値として返されます。ディスクの空き容量ではなく、パーティション全体の合計サイズを調べたい場合に便利な関数です。

構文

disk_total_space(dir_name)

パラメータ

• dir_name − 総容量を調べたいディレクトリ名を文字列で指定します。Windows環境の場合は「C:」のようにドライブ名を指定することもできます。

戻り値

指定したディレクトリが存在するファイルシステムの総容量をバイト数で返します。処理に失敗した場合はfalseを返します。

使用例

まずは、最もシンプルな使い方から見てみましょう。

<?php
    echo disk_total_space("/home/");
?>

出力

944459485184

このように、バイト数がそのまま数値として出力されます。次に、変数に格納してメッセージと一緒に表示する例を紹介します。

使用例

<?php
    $total_space = disk_total_space("/home/");
    echo "総容量: $total_space";
?>

出力

総容量: 944459485184

補足：見やすい単位に変換する方法

戻り値はバイト単位のため、そのままでは直感的に把握しづらいことがあります。以下のように計算してGB単位に変換すると、より読みやすい表示になります。

<?php
    $total_gb = round(disk_total_space("/home/") / pow(1024, 3), 2);
    echo "総容量: {$total_gb} GB";
?>

また、空き容量を確認したい場合は、同じく組み込み関数であるdisk_free_space()を使用します。両者を組み合わせれば、使用率の算出なども簡単に行えます。