- PHP Manual
- セッション関数
- セッションクッキーパラメータを設定する
session_set_cookie_params
(PHP 4, PHP 5, PHP 7)
session_set_cookie_params — セッションクッキーパラメータを設定する
説明
session_set_cookie_params
( int $lifetime_or_options
[, string|null $path = null
[, string|null $domain = null
[, bool|null $secure = null
[, bool|null $httponly = null
]]]] ) : bool
session_set_cookie_params
( array $lifetime_or_options
) : bool
ファイル php.ini で定義されたクッキーパラメータを設定します。
この関数の効果が持続するのは、スクリプトの実行が終了するまでです。
したがって、リクエスト毎や session_start()
がコールされる前に session_set_cookie_params()
をコールする必要があります。
この関数は、PHP の ini 設定の値を実行時に上書きします。値の取得には ini_get() が使えます。
パラメータ
lifetime_or_options最初のシグネチャを使う場合、セッションクッキーの 有効期限。秒数で定義します。
二番目のシグネチャを使う場合、 以下に示すキーを持つことができる連想配列です。
lifetime,path,domain,secure,httponlyおよびsamesite. 対応する値は、キーと同じ名前のパラメータで説明されているものと同じ意味です。samesite要素の値は、LaxまたはStrictになるはずです。 上記の許可されているオプションがいずれも設定されなかった場合、 デフォルト値は、明示的なパラメーターのデフォルト値と同じです。samesite要素が省略されると、SameSite クッキー属性は設定されません。pathクッキーが動作するドメイン上の パス。単一のスラッシュ ('/') を指定すると、ドメイン上のすべてのパスで動作します。
domainクッキーの ドメイン。たとえば 'www.php.net'。 すべてのサブドメインでクッキーを有効にしたい場合は、先頭にドットをつけて '.php.net' のようにします。
securetrueの場合は、セキュア な接続の場合にのみクッキーを送信します。httponlytrueの場合は、PHP でセッションクッキーを設定する際に httponly フラグの送信を試みます。
返り値
成功した場合に true を、失敗した場合に false を返します。
変更履歴
| バージョン | 説明 |
|---|---|
| 8.0.0 | path, domain,
|
| 7.3.0 | 連想配列 lifetime_or_options をサポートする、
別のシグナチャが追加されました。 このシグナチャは、SameSite クッキー属性の設定もサポートします。 |
| 7.2.0 | 成功した場合に true を、失敗した場合に false を返します。 以前はこの関数は void を返していました。
|
