【PHP8.x】COOKIE定数の使い方

Copy
1<?php
2
3/**
4 * 指定された名前のクッキーを削除します。
5 * クッキーを削除するには、値を空にし、有効期限を過去に設定します。
6 *
7 * 重要: クッキーを削除するためには、setcookie() の $path, $domain, $secure, $httponly の引数が、
8 *      元のクッキーを設定した際と同じである必要があります。
9 *      これらの引数が一致しない場合、ブラウザは目的のクッキーを削除しない可能性があります。
10 *
11 * @param string $name クッキーの名前
12 * @param string $path オプション。クッキーのパス。デフォルトは '/'。
13 * @param string $domain オプション。クッキーのドメイン。デフォルトは空（現在のドメイン）。
14 * @param bool $secure オプション。クッキーが HTTPS 接続でのみ送信されるべきか。デフォルトは false。
15 * @param bool $httponly オプション。JavaScript からアクセスできないようにするか。デフォルトは false。
16 * @return bool クッキーの削除ヘッダーが正常に送信されたかどうか (HTTP ヘッダーがまだ送信されていない場合のみ成功します)
17 */
18function deleteCookie(
19    string $name,
20    string $path = '/',
21    string $domain = '',
22    bool $secure = false,
23    bool $httponly = false
24): bool {
25    // クッキーを削除するために、値を空にし、有効期限を過去に設定します。
26    // time() - 3600 は現在時刻より1時間前のUnixタイムスタンプであり、これによりブラウザにクッキーを削除するよう促します。
27    $expirationTime = time() - 3600;
28
29    return setcookie($name, '', $expirationTime, $path, $domain, $secure, $httponly);
30}
31
32// --- 使用例 (このコードは直接実行しても効果はありません。HTTPリクエストの一部として実行する必要があります) ---
33
34// 'user_session' という名前のクッキーを削除する例
35// deleteCookie('user_session');
36
37// 特定のパスとドメイン、セキュア属性とHTTPオンリー属性を持つ 'tracking_id' クッキーを削除する例
38// 例えば、元のクッキーが以下のように設定されていた場合:
39// setcookie('tracking_id', 'some_value', time() + 3600, '/app/', 'example.com', true, true);
40// そのクッキーを削除するには、同じ引数を使用します:
41// deleteCookie('tracking_id', '/app/', 'example.com', true, true);
42
43// ------------------------------------------------------------------------------------------------

このPHPコードは、指定された名前のクッキーを削除するためのdeleteCookie関数を定義しています。クッキーを削除するには、setcookie()関数を使用して、クッキーの値を空に設定し、有効期限を過去の日時に設定する必要があります。

deleteCookie関数は、以下の引数を受け取ります。

• $name: 削除するクッキーの名前（必須）。
• $path: クッキーのパス（省略可能、デフォルトは'/'）。
• $domain: クッキーのドメイン（省略可能、デフォルトは空文字列で現在のドメイン）。
• $secure: クッキーがHTTPS接続でのみ送信されるかどうか（省略可能、デフォルトはfalse）。
• $httponly: JavaScriptからのアクセスを禁止するかどうか（省略可能、デフォルトはfalse）。

関数は、クッキーの削除ヘッダーが正常に送信されたかどうかを示すブール値を返します。ただし、HTTPヘッダーが既に送信されている場合は、常にfalseを返します。

重要な注意点: クッキーを正しく削除するには、setcookie()でクッキーを設定した際と全く同じ$path、$domain、$secure、$httponly引数を指定する必要があります。これらの引数が一致しない場合、ブラウザはクッキーを削除しない可能性があります。

例として、'user_session'という名前のクッキーを削除する場合、deleteCookie('user_session');のように呼び出します。また、パスやドメインなどが指定されたクッキーを削除する場合は、deleteCookie('tracking_id', '/app/', 'example.com', true, true);のように、同じ引数を指定します。

Copy
1<?php
2
3/**
4 * DateTimeImmutable::COOKIE 定数を使用してクッキーの有効期限を設定し、そのクッキーを取得するサンプルです。
5 *
6 * DateTimeImmutable::COOKIE は、Webクッキーの有効期限などで使用される RFC 822 形式の日付フォーマット文字列 ("D, d M Y H:i:s T") を提供します。
7 * このサンプルでは、この定数を使って現在時刻から1時間後の日付文字列を生成し、クッキーの有効期限として設定します。
8 */
9
10/**
11 * クッキーの設定と取得を処理する関数
12 *
13 * @return void
14 */
15function handleCookieExample(): void
16{
17    // 1. クッキー名と値を定義
18    $cookieName = 'my_app_cookie';
19    $cookieValue = 'Hello from PHP Cookie!';
20
21    // 2. DateTimeImmutable::COOKIE フォーマットを使用して有効期限を生成
22    // 現在から1時間後の日時オブジェクトを作成
23    $dateTime = new DateTimeImmutable('+1 hour');
24    // DateTimeImmutable::COOKIE 定数で指定された形式で日付文字列をフォーマット
25    $expireTimeFormatted = $dateTime->format(DateTimeImmutable::COOKIE);
26
27    // 3. クッキーを設定
28    // setcookie() は、ブラウザにクッキーを送信する命令です。
29    // 同じリクエスト内では $_COOKIE には反映されず、次のリクエストから有効になります。
30    if (!isset($_COOKIE[$cookieName])) {
31        // setcookie のオプションを配列で渡す（PHP 7.3以降推奨）
32        setcookie(
33            $cookieName,
34            $cookieValue,
35            [
36                'expires' => strtotime($expireTimeFormatted), // 有効期限をUnixタイムスタンプで指定
37                'path' => '/',                                // クッキーが有効なパス (通常はサイト全体 '/')
38                'secure' => false,                            // HTTPS接続でのみ送信するか (開発環境では false でも可)
39                'httponly' => true,                           // JavaScriptからのアクセスを禁止するか (セキュリティ強化)
40                'samesite' => 'Lax'                           // CSRF対策 (Lax, Strict, None)
41            ]
42        );
43        echo "クッキー '{$cookieName}' を設定しました。<br>";
44        echo "設定された有効期限: {$expireTimeFormatted}<br>";
45        echo "このクッキーは、ブラウザがページを再読み込みした後に利用可能になります。<br><br>";
46    } else {
47        echo "クッキー '{$cookieName}' は既に設定されています。<br><br>";
48    }
49
50    // 4. クッキーの取得
51    // $_COOKIE スーパーグローバル変数から、既にブラウザから送信されたクッキーを取得できます。
52    // setcookie() で設定したばかりのクッキーは、この現在のリクエストでは取得できません。
53    if (isset($_COOKIE[$cookieName])) {
54        echo "ブラウザから送信されたクッキー '{$cookieName}' の値: " . htmlspecialchars($_COOKIE[$cookieName]) . "<br>";
55    } else {
56        echo "クッキー '{$cookieName}' はまだ取得できません。ページをリロードして確認してください。<br>";
57    }
58
59    echo "<br>";
60
61    // 参考：DateTimeImmutable::COOKIE 定数そのものの値
62    echo "DateTimeImmutable::COOKIE 定数の値: " . DateTimeImmutable::COOKIE . "<br>";
63}
64
65// 関数を実行して、クッキーの処理を開始
66handleCookieExample();
67
68?>

このサンプルコードは、PHPでWebクッキーを設定し、その値を取得する方法を示しています。特にDateTimeImmutable::COOKIE定数を使って、クッキーの有効期限をRFC 822形式で正しくフォーマットする点に焦点を当てています。

DateTimeImmutable::COOKIEは、Webクッキーの有効期限として標準的に使用される日付形式「D, d M Y H:i:s T」（例: "Thu, 01 Jan 2025 12:00:00 GMT"）を定義する文字列定数です。この定数自体は引数を受け取らず、戻り値もありませんが、DateTimeImmutableオブジェクトのformat()メソッドに渡すことで、指定された形式の日付文字列を生成するために利用されます。

サンプルではまず、現在時刻から1時間後の日時を表すDateTimeImmutableオブジェクトを作成し、DateTimeImmutable::COOKIE定数を使ってこの日時をクッキーの有効期限フォーマットに変換しています。次に、setcookie()関数を用いて、指定したクッキー名と値、そして生成した有効期限を含むオプションを設定し、ブラウザにクッキーを送信するよう指示しています。setcookie()関数はブラウザにクッキーを送信する命令であり、この関数を実行した直後の同じリクエスト内では、設定したクッキーはまだPHPの$_COOKIEスーパーグローバル変数には反映されません。これは、クッキーがブラウザから次のリクエストでサーバーに送り返されるためです。

その後、$_COOKIE変数を使って、既にブラウザからサーバーに送信されたクッキーの値を参照しています。初めてページを読み込んだ際はsetcookie()で設定されたクッキーはすぐには取得できず、ページを再読み込みすることで$_COOKIEから取得できるようになる仕組みも示されており、PHPでのクッキーのライフサイクルと、設定と取得のタイミングを理解することができます。