PHP・WordPressにおけるrecurse_dirsize()関数を解説：ディレクトリサイズの再帰的取得方法

// $directory には対象となるディレクトリのパスが格納されている
if ( ! file_exists( $directory ) || ! is_dir( $directory ) ) {
    // ディレクトリが存在しない場合、またはディレクトリでない場合は false を返す
    return false;
}

// 対象ディレクトリが存在しなければ false が返される

// $directory の読み取り権限があるかチェック
if ( ! is_readable( $directory ) ) {
    // 読み取りが不可能なディレクトリの場合は false を返す
    return false;
}

// 読み取り権限がない場合、ここで処理が中断され false が返される

if ( is_file( $path ) ) {
    // ファイルサイズを取得して加算する
    $size += filesize( $path );
}

// 指定されたファイルのサイズがバイト単位で $size に加算される

if ( is_dir( $path ) ) {
    // 再帰的にサブディレクトリのサイズを計算する
    $dirSize = recurse_dirsize( $path, $exclude, $max_execution_time, $directory_cache );
    if ( $dirSize !== false ) {
        $size += $dirSize;
    }
}

// サブディレクトリ内のファイルサイズが再帰的に合計される

// WP_START_TIMESTAMP はスクリプトの開始時刻を示す定数
if ( $max_execution_time > 0 && ( microtime( true ) - WP_START_TIMESTAMP ) > $max_execution_time ) {
    // 設定時間を超えた場合、タイムアウトとして中断する
    $size = null;
    break;
}

// 実行時間が制限を超えた場合、処理がタイムアウトで中断される

// $exclude は除外対象のパス、文字列またはパスの配列
if ( ( is_string( $exclude ) && $directory === $exclude ) ||
     ( is_array( $exclude ) && in_array( $directory, $exclude, true ) )
) {
    // 除外対象の場合は再帰計算を行わず false を返す
    return false;
}

// 除外対象のディレクトリが検出された場合、処理は中断され false が返される

// 除外対象の場合、対象ディレクトリの再帰計算を行わない
if ( ( is_string( $exclude ) && $directory === $exclude ) ||
     ( is_array( $exclude ) && in_array( $directory, $exclude, true ) )
) {
    return false;
}

// 除外設定が有効なディレクトリの場合、計算処理がスキップされ false が返される

if ( ! file_exists( $directory ) || ! is_dir( $directory ) ) {
    // 無効なディレクトリパスの場合、エラーとして false を返す
    return false;
}

// 無効なディレクトリであると判定された場合、false が返される

if ( $max_execution_time > 0 && ( microtime( true ) - WP_START_TIMESTAMP ) > $max_execution_time ) {
    // タイムアウトに達した場合、中断して null を返す
    $size = null;
    break;
}

// タイムアウト条件に該当すると、計算処理が中断され null が返される

// pre_recurse_dirsize フィルターを利用してサイズ計算をカスタマイズする例
$size = apply_filters( 'pre_recurse_dirsize', false, $directory, $exclude, $max_execution_time, $directory_cache );
if ( false !== $size ) {
    // カスタマイズされたサイズが返された場合は、その値を利用する
    return $size;
}

// カスタムフックで処理が上書きされた場合、そのサイズが返される

// functions.php あるいはカスタムプラグイン内にコールバック関数を定義する例
add_filter( 'pre_recurse_dirsize', 'custom_dirsize_handler', 10, 5 );
function custom_dirsize_handler( $space_used, $directory, $exclude, $max_execution_time, $directory_cache ) {
    if ( '/var/www/html/wp-content/uploads' === $directory ) {
        // 特定ディレクトリの場合、固定のサイズ値を返す
        return 987654321;
    }
    // 他の場合は、デフォルト値を返す
    return $space_used;
}

// /var/www/html/wp-content/uploads の場合、987654321 バイトが返される

// $directory_cache 配列にキャッシュが存在するかをチェックする
if ( isset( $directory_cache[ $directory ] ) && is_int( $directory_cache[ $directory ] ) ) {
    return $directory_cache[ $directory ];
}

// キャッシュが有効であれば、キャッシュ内のサイズ値が返される

// トップレベルの呼び出しでキャッシュを保存する例
$expiration = ( wp_using_ext_object_cache() ) ? 0 : 10 * YEAR_IN_SECONDS;
set_transient( 'dirsize_cache', $directory_cache, $expiration );

// キャッシュされたディレクトリサイズ情報がトランジェントAPIに保存される

// スクリプト開始時刻と現在時刻との差を計算して実行時間を管理する
$currentTime = microtime( true );
$elapsedTime = $currentTime - WP_START_TIMESTAMP;
if ( $elapsedTime > $max_execution_time ) {
    // 実行時間超過の場合は中断処理へ移行する
    $size = null;
    break;
}

// 指定された実行時間を超えると、タイムアウトとして処理が中断される

// 各ループ内でタイムアウト条件をチェックする例
if ( $max_execution_time > 0 && ( microtime( true ) - WP_START_TIMESTAMP ) > $max_execution_time ) {
    // 実行時間が上限を超えた場合、中断して null を返す
    $size = null;
    break;
}

// 中断条件に達すると、再帰処理中のループが break され、null が返される