Source of: /manual/en/function.session-name.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = 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 => 'en',
),
'this' =>
array (
0 => 'function.session-name.php',
1 => 'session_name',
),
'up' =>
array (
0 => 'ref.session.php',
1 => 'Session Functions',
),
'prev' =>
array (
0 => 'function.session-module-name.php',
1 => 'session_module_name',
),
'next' =>
array (
0 => 'function.session-regenerate-id.php',
1 => 'session_regenerate_id',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.session-name" class="refentry">
<div class="refnamediv">
<h1 class="refname">session_name</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">session_name</span> — <span class="dc-title">Get and/or set the current session name</span></p>
</div>
<a name="function.session-name.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>session_name</b></span>
([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$name</tt></span>
] )</div>
<p class="para rdfs-comment">
<b>session_name()</b> returns the name of the current
session.
</p>
<p class="para">
The session name is reset to the default value stored in
<i>session.name</i> at request startup time. Thus, you need to
call <b>session_name()</b> for every request (and before
<a href="function.session-start.php" class="function">session_start()</a> or <a href="function.session-register.php" class="function">session_register()</a>
are called).
</p>
</div>
<a name="function.session-name.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">name</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The session name references the session id in cookies and URLs. It
should contain only alphanumeric characters; it should be short and
descriptive (i.e. for users with enabled cookie warnings).
If <i><tt class="parameter">name</tt></i>
is specified, the name of the current
session is changed to its value.
</p>
<p class="para">
<div class="warning"><b class="warning">Warning</b>
<p class="para">
The session name can't consist of digits only, at least one letter
must be present. Otherwise a new session id is generated every time.
</p>
</div>
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.session-name.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the name of the current session.
</p>
</div>
<a name="function.session-name.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>session_name()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?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"><br />"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.session-name.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member">
The <a href="session.configuration.php#ini.session.name" class="link">session.name</a> configuration
directive
</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
