session_id

(PHP 4, PHP 5, PHP 7, PHP 8)

session_id現在のセッション ID を取得または設定する

説明

session_id(?string $id = null): string|false

session_id() は現在のセッション ID を取得 または設定するために使用されます。

現在の名前とセッション ID を、URL に追加可能な文字列として取得する ために定数 SID も使用できます。 セッションハンドリング も参照してください。

パラメータ

id

id が指定され、null でない場合、現在の セッション ID を置換します。その際、 この関数は session_start() より前にコールされている必要があります。 セッションハンドラによっては、セッション ID として使用できる文字に 制限がある場合があります。例えば、ファイルによるセッションハンドラでは セッション ID として使える文字は a-z A-Z 0-9 , (カンマ) そして - (マイナス) に限られます!

注意: セッション保持にクッキーを使用している場合、 session_id() において id 引数を指定すると、 現在のセッション ID がセットされるものと まったく同一であるかどうかに関わらず、 session_start() が呼び出される際に常に新しいクッキーが送信されます。

戻り値

session_id() は現在のセッションのセッション ID を返します。 現在のセッションが存在しない (現在のセッション ID が存在しない) 場合は空文字列 ("") を返します。 失敗時には、false を返します。

変更履歴

バージョン 説明
8.0.0 id は、nullable になりました。

参考

関連キーワード:  セッション, 設定, 取得, 関数, ハンドラ, handler, 存在, 文字, クッキー, string