<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.session.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.session-set-cookie-params.php',
    1 => 'session_set_cookie_params',
    2 => 'セッションクッキーパラメータを設定する',
  ),
  'up' => 
  array (
    0 => 'ref.session.php',
    1 => 'セッション関数',
  ),
  'prev' => 
  array (
    0 => 'function.session-save-path.php',
    1 => 'session_save_path',
  ),
  'next' => 
  array (
    0 => 'function.session-set-save-handler.php',
    1 => 'session_set_save_handler',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/session/functions/session-set-cookie-params.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.session-set-cookie-params" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">session_set_cookie_params</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">session_set_cookie_params</span> &mdash; <span class="dc-title">セッションクッキーパラメータを設定する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.session-set-cookie-params-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>session_set_cookie_params</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$lifetime_or_options</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$path</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$domain</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span> <code class="parameter">$secure</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span> <code class="parameter">$httponly</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">PHP 7.3.0 以降で使える代替のシグネチャ:</p>
  <div class="methodsynopsis dc-description"><span class="methodname"><strong>session_set_cookie_params</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$lifetime_or_options</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   ファイル <var class="filename">php.ini</var> で定義されたクッキーパラメータを設定します。
   この関数の効果が持続するのは、スクリプトの実行が終了するまでです。
   したがって、リクエスト毎や <span class="function"><a href="function.session-start.php" class="function">session_start()</a></span>
   がコールされる前に <span class="function"><strong>session_set_cookie_params()</strong></span>
   をコールする必要があります。
  </p>
  <p class="para">
   この関数は、PHP の ini 設定の値を実行時に上書きします。値の取得には
   <span class="function"><a href="function.ini-get.php" class="function">ini_get()</a></span> が使えます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.session-set-cookie-params-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">lifetime_or_options</code></dt>
     <dd>
      <p class="para">
       最初のシグネチャを使う場合、セッションクッキーの <a href="session.configuration.php#ini.session.cookie-lifetime" class="link">有効期限</a>。秒数で定義します。
      </p>
      <p class="para">
       二番目のシグネチャを使う場合、
       以下に示すキーを持つことができる連想配列です。
       <code class="literal">lifetime</code>, <code class="literal">path</code>, <code class="literal">domain</code>,
       <code class="literal">secure</code>, <code class="literal">httponly</code> および <code class="literal">samesite</code>.

       対応する値は、キーと同じ名前のパラメータで説明されているものと同じ意味です。
       <code class="literal">samesite</code> 要素の値は、
       <code class="literal">Lax</code> または <code class="literal">Strict</code> になるはずです。

       上記の許可されているオプションがいずれも設定されなかった場合、
       デフォルト値は、明示的なパラメーターのデフォルト値と同じです。
       <code class="literal">samesite</code> 要素が省略されると、SameSite クッキー属性は設定されません。
      </p>
     </dd>
    
    
     <dt><code class="parameter">path</code></dt>
     <dd>
      <p class="para">
       クッキーが動作するドメイン上の
       <a href="session.configuration.php#ini.session.cookie-path" class="link">パス</a>。単一のスラッシュ (&#039;/&#039;)
       を指定すると、ドメイン上のすべてのパスで動作します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">domain</code></dt>
     <dd>
      <p class="para">
       クッキーの <a href="session.configuration.php#ini.session.cookie-domain" class="link">ドメイン</a>。たとえば &#039;www.php.net&#039;。
       すべてのサブドメインでクッキーを有効にしたい場合は、先頭にドットをつけて
       &#039;.php.net&#039; のようにします。
      </p>
     </dd>
    
    
     <dt><code class="parameter">secure</code></dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> の場合は、<a href="session.configuration.php#ini.session.cookie-secure" class="link">セキュア</a>
       な接続の場合にのみクッキーを送信します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">httponly</code></dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> の場合は、PHP でセッションクッキーを設定する際に
       <a href="session.configuration.php#ini.session.cookie-httponly" class="link">httponly</a> フラグの送信を試みます。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.session-set-cookie-params-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.session-set-cookie-params-changelog">
  <h3 class="title">変更履歴</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>バージョン</th>
       <th>説明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.0.0</td>
       <td>
        <code class="parameter">path</code>, <code class="parameter">domain</code>,
        <code class="parameter">secure</code>, <code class="parameter">httponly</code> は、
        nullable になりました。
       </td>
      </tr>

      <tr>
       <td>7.3.0</td>
       <td>
        連想配列 <code class="parameter">lifetime_or_options</code> をサポートする、
        別のシグネチャが追加されました。
        このシグネチャは、SameSite クッキー属性の設定もサポートします。
       </td>
      </tr>

      <tr>
       <td>7.2.0</td>
       <td>
        成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。 以前はこの関数は <span class="type"><span class="type"><a href="language.types.void.php" class="type void">void</a></span></span> を返していました。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.session-set-cookie-params-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li>
     <a href="session.configuration.php#ini.session.cookie-lifetime" class="link">session.cookie_lifetime</a>
    </li>
    <li>
     <a href="session.configuration.php#ini.session.cookie-path" class="link">session.cookie_path</a>
    </li>
    <li>
     <a href="session.configuration.php#ini.session.cookie-domain" class="link">session.cookie_domain</a>
    </li>
    <li>
     <a href="session.configuration.php#ini.session.cookie-secure" class="link">session.cookie_secure</a>
    </li>
    <li>
     <a href="session.configuration.php#ini.session.cookie-httponly" class="link">session.cookie_httponly</a>
    </li>
    <li>
     <a href="session.configuration.php#ini.session.cookie-samesite" class="link">session.cookie_samesite</a>
    </li>
    <li><span class="function"><a href="function.session-get-cookie-params.php" class="function" rel="rdfs-seeAlso">session_get_cookie_params()</a> - セッションクッキーのパラメータを得る</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>