【PHP8.x】session_status()関数の使い方

Copy
1<?php
2
3/**
4 * PHPのセッション状態を確認するサンプルコード。
5 * session_status()関数は、セッションの現在の状態を整数値で返します。
6 * 主な状態として、PHP_SESSION_NONE (1: セッションは有効だが未開始) と
7 * PHP_SESSION_ACTIVE (2: セッションは有効で開始済み) があります。
8 */
9function displaySessionStatus(): void
10{
11    echo "--- セッション開始前の状態 ---" . PHP_EOL;
12
13    // session_start() を呼び出す前のセッションの状態を確認
14    $statusBefore = session_status();
15    echo "session_status() の戻り値: " . $statusBefore . PHP_EOL;
16
17    if ($statusBefore === PHP_SESSION_NONE) {
18        echo "現在のセッション状態: PHP_SESSION_NONE (1) - セッションは有効ですが、開始されていません。" . PHP_EOL;
19    } elseif ($statusBefore === PHP_SESSION_ACTIVE) {
20        echo "現在のセッション状態: PHP_SESSION_ACTIVE (2) - セッションは有効で、開始されています。" . PHP_EOL;
21    } elseif ($statusBefore === PHP_SESSION_DISABLED) {
22        echo "現在のセッション状態: PHP_SESSION_DISABLED (0) - セッションは無効です。" . PHP_EOL;
23    }
24
25    echo PHP_EOL; // 空行
26
27    echo "--- セッションを開始します ---" . PHP_EOL;
28    // セッションを開始
29    session_start();
30    echo "session_start() を呼び出しました。" . PHP_EOL;
31
32    echo PHP_EOL; // 空行
33
34    echo "--- セッション開始後の状態 ---" . PHP_EOL;
35
36    // session_start() を呼び出した後のセッションの状態を確認
37    $statusAfter = session_status();
38    echo "session_status() の戻り値: " . $statusAfter . PHP_EOL;
39
40    if ($statusAfter === PHP_SESSION_NONE) {
41        echo "現在のセッション状態: PHP_SESSION_NONE (1) - セッションは有効ですが、開始されていません。" . PHP_EOL;
42    } elseif ($statusAfter === PHP_SESSION_ACTIVE) {
43        echo "現在のセッション状態: PHP_SESSION_ACTIVE (2) - セッションは有効で、開始されています。" . PHP_EOL;
44        // セッションがアクティブなので、セッション変数にアクセスできます。
45        $_SESSION['user_id'] = 123;
46        echo "セッション変数 '_SESSION[\"user_id\"]' を設定しました。" . PHP_EOL;
47    } elseif ($statusAfter === PHP_SESSION_DISABLED) {
48        echo "現在のセッション状態: PHP_SESSION_DISABLED (0) - セッションは無効です。" . PHP_EOL;
49    }
50}
51
52// 関数を実行してセッションの状態を表示
53displaySessionStatus();
54

session_status関数は、PHPのセッション機能が現在どのような状態にあるかを確認するために使用される関数です。引数は不要で、現在のセッションの状態を示す整数値を戻り値として返します。

この整数値は、主に以下の3つの定数で意味付けられています。PHP_SESSION_DISABLED（0）はセッションが無効になっている状態、PHP_SESSION_NONE（1）はセッション機能は有効ですがまだ開始されていない状態、そしてPHP_SESSION_ACTIVE（2）はセッションがすでに開始されており、利用可能な状態を示します。

サンプルコードでは、まずsession_start()関数を呼び出す前にsession_status()を実行し、セッションが開始されていないPHP_SESSION_NONE（1）の状態であることを確認しています。次にsession_start()でセッションを開始した後、再度session_status()を実行すると、セッションが開始されPHP_SESSION_ACTIVE（2）の状態に変化していることが示されます。セッションがアクティブな状態（2）になると、$_SESSIONのようなスーパーグローバル変数を通じてセッションデータの読み書きが可能になります。このように、この関数を使うことで、セッションの状態に応じて適切な処理を行うことができます。

Copy
1<?php
2
3/**
4 * session_status() 関数の使用例を示します。
5 * この関数は現在のセッションの状態を整数で返します。
6 *
7 * 戻り値は以下の定数と対応します:
8 * PHP_SESSION_DISABLED (0): セッション機能が無効化されている
9 * PHP_SESSION_NONE     (1): セッションは有効だが、現在のリクエストでセッションが開始されていない
10 * PHP_SESSION_ACTIVE   (2): セッションは有効で、現在のリクエストでセッションが開始されている
11 */
12function demonstrateSessionStatus(): void
13{
14    echo "--- セッション開始前の状態確認 ---\n";
15
16    // セッション開始前の session_status() の戻り値は通常 PHP_SESSION_NONE (1) となります。
17    // これは、PHP のセッション機能自体は有効だが、このスクリプトでまだ session_start() が
18    // 呼び出されていない状態を示します。
19    $statusBeforeStart = session_status();
20    echo "session_status() の最初の呼び出し結果: " . $statusBeforeStart . "\n";
21    echo "PHP_SESSION_NONE の値: " . PHP_SESSION_NONE . "\n";
22
23    if ($statusBeforeStart === PHP_SESSION_NONE) {
24        echo "=> 現在、セッションは有効ですが、まだ開始されていません。\n";
25        echo "   (session_status() は " . PHP_SESSION_NONE . " を返しました。)\n";
26    }
27
28    echo "\n--- セッション開始後の状態確認 ---\n";
29
30    // session_start() を呼び出してセッションを開始します。
31    // これにより、$_SESSION スーパーグローバル配列が利用可能になります。
32    session_start();
33    echo "session_start() を呼び出しました。\n";
34
35    // session_start() 呼び出し後の session_status() の戻り値は PHP_SESSION_ACTIVE (2) となります。
36    $statusAfterStart = session_status();
37    echo "session_status() の2回目の呼び出し結果: " . $statusAfterStart . "\n";
38    echo "PHP_SESSION_ACTIVE の値: " . PHP_SESSION_ACTIVE . "\n";
39
40    if ($statusAfterStart === PHP_SESSION_ACTIVE) {
41        echo "=> 現在、セッションは開始され、アクティブな状態です。\n";
42        echo "   (session_status() は " . PHP_SESSION_ACTIVE . " を返しました。)\n";
43    }
44
45    // セッションがアクティブな場合、セッション変数に値を設定できます。
46    if ($statusAfterStart === PHP_SESSION_ACTIVE) {
47        $_SESSION['user_id'] = 123;
48        echo "セッション変数 'user_id' に値を設定しました: " . $_SESSION['user_id'] . "\n";
49    }
50
51    echo "\n--- スクリプト終了 ---\n";
52}
53
54// 関数を実行します。
55demonstrateSessionStatus();
56
57?>

PHPのsession_status()関数は、現在のPHPセッションの状態を確認するための関数です。この関数は引数を取らず、セッションの状態を示す整数値を返します。戻り値の整数は、PHPの標準定数と対応しており、主に三つの状態を示します。セッション機能が無効化されている場合はPHP_SESSION_DISABLED (0)、セッションは有効ですがまだ開始されていない場合はPHP_SESSION_NONE (1)、セッションが開始されアクティブな状態の場合はPHP_SESSION_ACTIVE (2)です。

提供されたサンプルコードでは、この関数の具体的な挙動が示されています。session_start()関数を呼び出す前は、通常session_status()はPHP_SESSION_NONE (1)を返します。これは、PHPのセッション機能自体は利用可能ですが、現在のリクエスト内でまだセッションが明示的に開始されていない状態を意味します。

次にsession_start()を呼び出してセッションを開始すると、その後のsession_status()の戻り値はPHP_SESSION_ACTIVE (2)となります。この状態になると、$_SESSIONというスーパーグローバル配列を通じてセッション変数にデータを保存したり、読み出したりすることが可能になります。例えば、ユーザーIDをセッションに保存するといった処理が行えます。session_status()関数は、ウェブアプリケーションでセッションの状態に応じて適切な処理を行うための分岐判断などで活用されます。

Copy
1<?php
2
3/**
4 * session_status() 関数の動作をデモンストレーションします。
5 *
6 * この関数は、PHPセッションが開始されているかどうかを判断するための
7 * session_status() 関数の使用方法と、その戻り値について解説します。
8 * 特に、キーワードである "session_status() == PHP_SESSION_ACTIVE" の
9 * 評価結果がどのように変わるかを示します。
10 */
11function demonstrateSessionStatus(): void
12{
13    echo "--- PHP session_status() 関数のデモンストレーション ---\n\n";
14
15    // 1. セッション開始前の状態を確認
16    // PHPスクリプトの実行開始直後、通常セッションはまだ開始されていません。
17    echo "1. セッションがまだ開始されていない状態:\n";
18    $statusBeforeStart = session_status();
19    echo "   現在のセッション状態: " . getSessionStatusName($statusBeforeStart) . "\n";
20
21    // キーワードに沿ったチェック: セッションがアクティブかどうか
22    if ($statusBeforeStart === PHP_SESSION_ACTIVE) {
23        echo "   -> キーワード評価: session_status() == PHP_SESSION_ACTIVE は TRUE です。\n";
24    } else {
25        echo "   -> キーワード評価: session_status() == PHP_SESSION_ACTIVE は FALSE です。\n";
26    }
27    echo "   (通常、この時点では 'PHP_SESSION_NONE' または 'PHP_SESSION_DISABLED' です)\n\n";
28
29    // 2. セッションを開始する
30    echo "2. session_start() を呼び出してセッションを開始:\n";
31    // session_start() は、既にセッションが開始されている場合に警告を出すため、
32    // 未開始であることを確認してから呼び出します。
33    if ($statusBeforeStart !== PHP_SESSION_ACTIVE) {
34        session_start();
35        echo "   session_start() を実行しました。\n";
36
37        // セッションデータを保存する例
38        $_SESSION['user_id'] = 123;
39        $_SESSION['username'] = 'BeginnerUser';
40        echo "   セッションデータ: user_id = " . $_SESSION['user_id'] . ", username = " . $_SESSION['username'] . " を保存しました。\n";
41    } else {
42        echo "   セッションは既に開始されています (session_start() はスキップされました)。\n";
43    }
44    echo "\n";
45
46    // 3. セッション開始後の状態を確認
47    // session_start() が実行されると、セッションは 'アクティブ' 状態になります。
48    echo "3. セッション開始後の状態:\n";
49    $statusAfterStart = session_status();
50    echo "   現在のセッション状態: " . getSessionStatusName($statusAfterStart) . "\n";
51
52    // キーワードに沿ったチェック: セッションがアクティブかどうか
53    if ($statusAfterStart === PHP_SESSION_ACTIVE) {
54        echo "   -> キーワード評価: session_status() == PHP_SESSION_ACTIVE は TRUE です。\n";
55        echo "   (この時点では 'PHP_SESSION_ACTIVE' であるはずです)\n";
56
57        // アクティブなセッションからデータを読み取る例
58        echo "   セッションデータから読み取り: ユーザー名 = " . ($_SESSION['username'] ?? '未設定') . "\n";
59    } else {
60        echo "   -> キーワード評価: session_status() == PHP_SESSION_ACTIVE は FALSE です。\n";
61        echo "   (予期せぬ状態です。PHPのセッション設定や環境を確認してください)\n";
62    }
63    echo "\n";
64}
65
66/**
67 * session_status() が返す整数値に対応する定数名を返します。
68 * 初心者でもセッションの状態を理解しやすくするためのヘルパー関数です。
69 *
70 * @param int $status session_status() の戻り値。
71 * @return string 対応するセッション状態の定数名。
72 */
73function getSessionStatusName(int $status): string
74{
75    switch ($status) {
76        case PHP_SESSION_DISABLED:
77            return 'PHP_SESSION_DISABLED'; // セッションが無効化されている
78        case PHP_SESSION_NONE:
79            return 'PHP_SESSION_NONE';     // セッションは有効だが、まだ開始されていない
80        case PHP_SESSION_ACTIVE:
81            return 'PHP_SESSION_ACTIVE';   // セッションは有効で、開始済み
82        default:
83            return '不明な状態';
84    }
85}
86
87// 上記で定義したデモンストレーション関数を実行します。
88demonstrateSessionStatus();
89
90?>

PHPのsession_status()関数は、現在のPHPセッションがどのような状態にあるかを確認するために利用されます。この関数は引数を一切取らず、セッションの状態を示す整数値（int）を戻り値として返します。具体的には、セッションが有効であるもののまだ開始されていない場合はPHP_SESSION_NONE、セッションが有効で既に開始されている場合はPHP_SESSION_ACTIVE、セッション機能自体がPHPの設定で無効化されている場合はPHP_SESSION_DISABLEDのいずれかの値を返します。

サンプルコードでは、まずsession_start()を呼び出す前のセッション状態を確認しています。この時点では通常PHP_SESSION_NONEが返されるため、キーワードであるsession_status() == PHP_SESSION_ACTIVEの評価結果はFALSEとなります。次にsession_start()を実行してセッションを明示的に開始すると、セッションは「アクティブ」な状態へ移行します。これにより、再度session_status()を呼び出した際にはPHP_SESSION_ACTIVEが返されるようになり、session_status() == PHP_SESSION_ACTIVEの評価結果はTRUEへと変化します。このように、session_status()を使用することで、Webアプリケーション内でセッションが正しく機能しているか、またはどの段階にあるかをプログラム的に判断し、適切な処理を行うための分岐に活用できます。

Copy
1<?php
2
3/**
4 * セッションの状態を確認し、必要であればセッションを開始するPHPのサンプルコードです。
5 *
6 * session_status() 関数は、現在のセッションの状態を整数で返します。
7 * 主な戻り値:
8 *   - PHP_SESSION_NONE (1): セッションは有効ですが、現在のリクエストでは開始されていません。
9 *   - PHP_SESSION_ACTIVE (2): セッションは有効で、現在のリクエストで既に開始されています。
10 *   - PHP_SESSION_DISABLED (0): セッションは無効化されています。
11 */
12
13// 現在のセッションの状態を取得します。
14$currentSessionStatus = session_status();
15
16// キーワード「session_status() == PHP_SESSION_NONE」に最も関連する判定を行います。
17// セッションがまだ開始されていない場合にのみ、session_start()を呼び出します。
18// これにより、二重にセッションを開始しようとすることによるエラーを防ぎます。
19if ($currentSessionStatus === PHP_SESSION_NONE) {
20    // セッションを開始します。これにより、$_SESSION スーパーグローバル変数が利用可能になります。
21    session_start();
22    echo "セッションが開始されていなかったため、新しくセッションを開始しました。<br>";
23} elseif ($currentSessionStatus === PHP_SESSION_ACTIVE) {
24    echo "セッションは既に開始されています。<br>";
25} else { // PHP_SESSION_DISABLED の場合
26    echo "セッションはPHPの設定で無効化されています。<br>";
27}
28
29// セッションが利用可能な場合のみ、セッション変数にアクセスします。
30if ($currentSessionStatus === PHP_SESSION_NONE || $currentSessionStatus === PHP_SESSION_ACTIVE) {
31    // 初めてアクセスする場合、'visit_count' セッション変数を初期化します。
32    if (!isset($_SESSION['visit_count'])) {
33        $_SESSION['visit_count'] = 0;
34    }
35    // ページがリロードされるたびに訪問回数を増やします。
36    $_SESSION['visit_count']++;
37
38    echo "現在のセッションID: " . session_id() . "<br>";
39    echo "このページへの訪問回数 (セッション内): " . $_SESSION['visit_count'] . "回<br>";
40    echo "ブラウザを閉じると、このセッションは終了し、訪問回数はリセットされます。<br>";
41}
42

PHPのsession_status()関数は、引数を取らず、現在のセッションの状態を示す整数を返します。この関数は、セッションが有効でありながらまだ開始されていない場合はPHP_SESSION_NONE（値は1）、既に開始されている場合はPHP_SESSION_ACTIVE（値は2）、PHPの設定で無効化されている場合はPHP_SESSION_DISABLED（値は0）を返します。

サンプルコードでは、まずsession_status()を呼び出して現在のセッション状態を取得しています。キーワードであるsession_status() == PHP_SESSION_NONEの判定は、セッションがまだ開始されていない場合にのみsession_start()関数を呼び出すために重要です。session_start()は一度しか呼び出すことができないため、この確認を行うことで「Warning: Session already started」といったエラーを防ぎ、安全にセッションを開始できます。

セッションが開始済み（PHP_SESSION_NONEからsession_start()で開始された場合、または元々PHP_SESSION_ACTIVEの場合）であれば、$_SESSIONスーパーグローバル変数を通じて、ユーザーごとのデータをサーバー側に保存できるようになります。この例では、$_SESSION['visit_count']を使って、ユーザーがページを訪問した回数をセッション内で保持し、表示しています。これにより、同じブラウザからのアクセス中は訪問回数が維持され、ブラウザを閉じるとセッションが終了し、このデータはリセットされます。