session_set_cookie_params
セッションクッキーパラメータを設定する
説明
bool session_set_cookie_params(
int $lifetime_or_options,
stringnull $path = null,
stringnull $domain = null,
boolnull $secure = null,
boolnull $httponly = null
)
bool session_set_cookie_params(array $lifetime_or_options)
この関数は、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' のようにします。
-
secure
-
true の場合は、セキュア
な接続の場合にのみクッキーを送信します。
-
httponly
-
true の場合は、PHP でセッションクッキーを設定する際に
httponly フラグの送信を試みます。
戻り値
成功した場合に true を、失敗した場合に false を返します。