<?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 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.session-name.php',
    1 => 'session_name',
    2 => '读取/设置会话名称',
  ),
  'up' => 
  array (
    0 => 'ref.session.php',
    1 => 'Session 函数',
  ),
  'prev' => 
  array (
    0 => 'function.session-module-name.php',
    1 => 'session_module_name',
  ),
  'next' => 
  array (
    0 => 'function.session-regenerate-id.php',
    1 => 'session_regenerate_id',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/session/functions/session-name.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.session-name" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">session_name</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">session_name</span> &mdash; <span class="dc-title">读取/设置会话名称</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.session-name-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>session_name</strong></span>(<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">$name</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>session_name()</strong></span> 函数返回当前会话名称。
   如果指定 <code class="parameter">name</code> 参数，
   <span class="function"><strong>session_name()</strong></span> 函数会更新会话名称，
   并返回 <em>原来的</em> 会话名称。
  </p>
  <p class="para">
   如果使用 <code class="parameter">name</code> 指定了新字符串作为会话 cookie 的名字，
   <span class="function"><strong>session_name()</strong></span> 函数会修改 HTTP 响应中的 cookie
   （如果启用了 <a href="session.configuration.php#ini.session.use-trans-sid" class="link">session.use_trans_sid</a>，还会输出会话 cookie 的内容）。
   一旦在 HTTP 响应中发送了 cookie 的内容之后，
   调用 <span class="function"><strong>session_name()</strong></span> 函数会产生 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>。
   所以，一定要在调用 <span class="function"><a href="function.session-start.php" class="function">session_start()</a></span> 函数之前
   调用此函数。
  </p>
  <p class="para">
   请求开始的时候，会话名称会被重置并且存储到
   <code class="literal">session.name</code> 配置项。
   因此，要想设置会话名称，那么对于每个请求，都需要在
   调用 <span class="function"><a href="function.session-start.php" class="function">session_start()</a></span> 函数
   之前调用 <span class="function"><strong>session_name()</strong></span> 函数。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.session-name-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">name</code></dt>
     <dd>
      <p class="para">
       用在 cookie 或者 URL 中的会话名称，
       例如：<code class="literal">PHPSESSID</code>。
       只能使用字母和数字作为会话名称，建议尽可能的短一些，
       并且是望文知意的名字（对于启用了 cookie 警告的用户来说，方便其判断是否要允许此 cookie）。
       如果指定了 <code class="parameter">name</code> 且不为 <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>，
       那么当前会话也会使用指定值作为名称。
      </p>
      <p class="para">
       <div class="warning"><strong class="warning">警告</strong>
        <p class="para">
         会话名称至少需要一个字母，不能全部都使用数字，
         否则，每次都会生成一个新的会话 ID。
        </p>
       </div>
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.session-name-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   返回当前会话名称。如果指定 <code class="parameter">name</code> 参数，那么此函数会更新会话名称，并且
   返回 <em>原来的</em> 会话名称， 或者在失败时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.session-name-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">name</code> 现在可以为 null。
       </td>
      </tr>

      <tr>
       <td>7.2.0</td>
       <td>
        <span class="function"><strong>session_name()</strong></span> 函数会检查会话状态，
        之前的版本仅仅检查 cookie 状态。
        所以，旧版本的 PHP 允许你在调用 <span class="function"><a href="function.session-start.php" class="function">session_start()</a></span>
        函数之后再调用 <span class="function"><strong>session_name()</strong></span> 函数，
        新版本的 PHP 不再允许这样做了。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.session-name-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 <span class="function"><strong>session_name()</strong></span> 示例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">/* set the session name to WebsiteID */<br /><br /></span><span style="color: #0000BB">$previous_name </span><span style="color: #007700">= </span><span style="color: #0000BB">session_name</span><span style="color: #007700">(</span><span style="color: #DD0000">"WebsiteID"</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"The previous session name was </span><span style="color: #0000BB">$previous_name</span><span style="color: #DD0000">&lt;br /&gt;"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.session-name-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li>
     <a href="session.configuration.php#ini.session.name" class="link">session.name</a> 
     配置指示
    </li>
   </ul>
  </p>
 </div>


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