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

disk_free_space関数は、指定されたファイルシステムまたはディレクトリの利用可能な空き容量をバイト単位で取得する関数です。この関数は、ウェブサーバーやアプリケーションが稼働するシステムのディスク領域がどれくらい残っているかを確認したい場合に非常に役立ちます。

利用する際は、引数として確認したいディレクトリのパスを文字列で指定します。このパスは、ルートからの絶対パス（例: /var/www/html）でも、現在のスクリプト位置からの相対パス（例: . や ./uploads）でも指定可能です。

関数が正常に実行されると、そのファイルシステムで利用可能な空き領域の合計バイト数を整数値として返します。例えば、10737418240バイトが空いている場合、この数値がそのまま返されます。もし何らかの理由で空き容量の取得に失敗した場合は、falseが戻り値として返されますので、この戻り値を確認して適切なエラー処理を行うことが重要です。

取得した値はバイト単位であるため、ユーザーに表示する際には、キロバイト（KB）、メガバイト（MB）、ギガバイト（GB）といった、人間が読みやすい単位に変換する処理を別途実装することが一般的です。この関数は、例えばユーザーがファイルをアップロードする前に十分なディスク空き容量があるかを確認したり、システムログなどの書き込み処理を行う前にディスク使用量を監視したりする際に活用できます。

<?php

$free_space_in_bytes = disk_free_space('/path/to/directory');

?>

string $directory

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

float|false

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