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

<?php

/**
 * session_gc() を使用してセッションのガベージコレクションを強制実行するサンプル。
 *
 * このスクリプトは、意図的に期限切れのセッションを作成し、
 * session_gc() を呼び出してクリーンアップされることを示します。
 * コマンドライン（CLI）から実行することを想定しています。
 */
function demonstrateSessionGarbageCollection(): void
{
    // 実行環境に影響を与えないよう、一時的なセッション保存パスを設定します。
    $sessionPath = sys_get_temp_dir() . '/php_gc_test_sessions';
    if (!is_dir($sessionPath)) {
        mkdir($sessionPath, 0777, true);
    }
    ini_set('session.save_path', $sessionPath);

    // テストのため、セッションの有効期限を1秒に設定します。
    ini_set('session.gc_maxlifetime', 1);

    // 1. 期限切れになるセッションを作成します。
    session_start();
    $_SESSION['user'] = 'test_user';
    $sessionId = session_id();
    // セッションファイルへの書き込みを確定させるために閉じます。
    session_write_close();
    echo "セッションを作成しました (ID: {$sessionId})。\n";

    // 2. gc_maxlifetime で設定した有効期限が切れるのを待ちます。
    echo "有効期限が切れるまで2秒待機します...\n";
    sleep(2);

    // 3. セッションのガベージコレクションを強制的に実行します。
    //    この関数は、期限切れのセッションファイルを削除します。
    $deletedCount = session_gc();

    if ($deletedCount === false) {
        echo "セッションのガベージコレクションに失敗しました。\n";
    } else {
        // 4. 削除されたセッションの数を表示します。
        echo "session_gc() の実行完了。{$deletedCount}個の期限切れセッションが削除されました。\n";
    }

    // 後片付け: テスト用に作成したディレクトリとファイルを削除します。
    $files = glob($sessionPath . '/*');
    foreach ($files as $file) {
        if (is_file($file)) {
            unlink($file);
        }
    }
    rmdir($sessionPath);
}

demonstrateSessionGarbageCollection();

session_gc()関数は、サーバー上に保存されている有効期限が切れたセッションデータを削除（クリーンアップ）する処理、いわゆるガベージコレクションを強制的に実行するための関数です。PHPのセッション管理では、このクリーンアップ処理は通常、設定に基づいて一定の確率で自動的に行われますが、session_gc()を使うことで任意のタイミングで明示的に実行できます。

この関数は引数を必要としません。

関数の戻り値は、処理が成功した場合に削除されたセッションの数を整数（int）で返します。何らかの理由で処理に失敗した場合はfalseが返されます。

サンプルコードでは、まずini_set()を用いてセッションの有効期限を意図的に1秒という短い時間に設定します。次にテスト用のセッションを作成し、有効期限が切れるのを2秒間待ってからsession_gc()を呼び出しています。その結果、戻り値として削除されたセッションの数が表示され、この関数が期限切れのセッションデータを正常にクリーンアップしたことを確認できます。