session_id
(PHP 4, PHP 5, PHP 7, PHP 8)
session_id — 現在のセッション ID を取得または設定する
説明
session_id() は現在のセッション ID を取得 または設定するために使用されます。
現在の名前とセッション ID を、URL に追加可能な文字列として取得する
ために定数 SID
も使用できます。
セッションハンドリング
も参照ください。
パラメータ
id
-
id
が指定され、null
でない場合、現在の セッション ID を置換します。その際、 この関数は session_start() より前にコールされている必要があります。 セッションハンドラによっては、セッション ID として使用できる文字に 制限がある場合があります。例えば、ファイルによるセッションハンドラでは セッション ID として使える文字は[a-zA-Z0-9,-]
に限られます!注意: セッション保持にクッキーを使用している場合、 session_id() において
id
引数を指定すると、 現在のセッション ID がセットされるものと まったく同一であるかどうかに関わらず、 session_start() が呼び出される際に常に新しいクッキーが送信されます。
戻り値
session_id() は現在のセッションのセッション ID を返します。
現在のセッションが存在しない (現在のセッション ID が存在しない)
場合は空文字列 (""
) を返します。
失敗時には、false
を返します。
変更履歴
バージョン | 説明 |
---|---|
8.0.0 |
id は、nullable になりました。
|
参考
- session_regenerate_id() - 現在のセッションIDを新しく生成したものと置き換える
- session_start() - 新しいセッションを開始、あるいは既存のセッションを再開する
- session_set_save_handler() - ユーザー定義のセッション保存関数を設定する
- session.save_handler
User Contributed Notes 1 note
It may be good to note that PHP does not allow arbitrary session ids. The session id validation in PHP source is defined in ext/session/session.c in the function php_session_valid_key:
https://github.com/php/php-src/blob/master/ext/session/session.c
To put it short, a valid session id may consists of digits, letters A to Z (both upper and lower case), comma and dash. Described as a character class, it would be [-,a-zA-Z0-9]. A valid session id may have the length between 1 and 128 characters. To validate session ids, the easiest way to do it use a function like:
<?php
function session_valid_id($session_id)
{
return preg_match('/^[-,a-zA-Z0-9]{1,128}$/', $session_id) > 0;
}
?>
session_id() itself will happily accept invalid session ids, but if you try to start a session using an invalid id, you will get the following error:
Warning: session_start(): The session id is too long or contains illegal characters, valid characters are a-z, A-Z, 0-9 and '-,'