関数・クラス解説

session_set_cookie_params

version:PHP 4, PHP 5, PHP 7 (公式)

セッションクッキーパラメータを設定する

公式リファレンス

書式

session_set_cookie_params ( int $lifetime [, string $path [, string $domain [, bool $secure = FALSE [, bool $httponly = FALSE ]]]] ) : bool

session_set_cookie_params ( array $options ) : bool

説明

ファイル php.ini で定義されたクッキーパラメータを設定します。 この関数の効果が持続するのは、スクリプトの実行が終了するまでです。 したがって、リクエスト毎や session_start() がコールされる前に session_set_cookie_params() をコールする必要があります。

この関数は、PHP の ini 設定の値を実行時に上書きします。値の取得には ini_get() が使えます。

パラメータ

lifetime
セッションクッキーの 有効期限。秒数で定義します。
path
クッキーが動作するドメイン上の パス。単一のスラッシュ ('/') を指定すると、ドメイン上のすべてのパスで動作します。
domain
クッキーの ドメイン。たとえば 'www.php.net'。 すべてのサブドメインでクッキーを有効にしたい場合は、先頭にドットをつけて '.php.net' のようにします。
secure
TRUE の場合は、セキュア な接続の場合にのみクッキーを送信します。
httponly
TRUE の場合は、PHP でセッションクッキーを設定する際に httponly フラグの送信を試みます。
options
以下に示すキーを持つことができる連想配列です。 lifetime, path, domain, secure, httponly および samesite. 対応する値は、キーと同じ名前のパラメータで説明されているものと同じ意味です。 samesite 要素の値は、 Lax または Strict になるはずです。 上記の許可されているオプションがいずれも設定されなかった場合、 デフォルト値は、明示的なパラメーターのデフォルト値と同じです。 samesite 要素が省略されると、SameSite クッキー属性は設定されません。

返値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

更新履歴

バージョン 説明
7.3.0 連想配列 options をサポートする、 別のシグナチャが追加されました。 このシグナチャは、SameSite クッキー属性の設定もサポートします。
7.2.0 成功した場合に TRUE を、失敗した場合に FALSE を返します。 以前はこの関数は void を返していました。

参考

  • session.cookie_lifetime
  • session.cookie_path
  • session.cookie_domain
  • session.cookie_secure
  • session.cookie_httponly
  • session.cookie_samesite
  • session_get_cookie_params() - セッションクッキーのパラメータを得る
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール