Source of: /manual/en/function.session-regenerate-id.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-regenerate-id.php',
1 => 'session_regenerate_id',
),
'up' =>
array (
0 => 'ref.session.php',
1 => 'Session Functions',
),
'prev' =>
array (
0 => 'function.session-name.php',
1 => 'session_name',
),
'next' =>
array (
0 => 'function.session-register.php',
1 => 'session_register',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.session-regenerate-id" class="refentry">
<div class="refnamediv">
<h1 class="refname">session_regenerate_id</h1>
<p class="verinfo">(PHP 4 >= 4.3.2, PHP 5)</p><p class="refpurpose"><span class="refname">session_regenerate_id</span> — <span class="dc-title">
Update the current session id with a newly generated one
</span></p>
</div>
<a name="function.session-regenerate-id.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>session_regenerate_id</b></span>
([ <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$delete_old_session</tt><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
<b>session_regenerate_id()</b> will replace the current
session id with a new one, and keep the current session information.
</p>
</div>
<a name="function.session-regenerate-id.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">delete_old_session</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Whether to delete the old associated session file or not. Defaults to
<b><tt class="constant">FALSE</tt></b>.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.session-regenerate-id.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.session-regenerate-id.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">4.3.3</td>
<td align="left">
Since then, if session cookies are enabled, use of
<b>session_regenerate_id()</b> will also submit a new
session cookie with the new session id.
</td>
</tr>
<tr valign="middle">
<td align="left">5.1.0</td>
<td align="left">
Added the <i><tt class="parameter">delete_old_session</tt></i>
parameter.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.session-regenerate-id.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 A <b>session_regenerate_id()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />session_start</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$old_sessionid </span><span style="color: #007700">= </span><span style="color: #0000BB">session_id</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">session_regenerate_id</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$new_sessionid </span><span style="color: #007700">= </span><span style="color: #0000BB">session_id</span><span style="color: #007700">();<br /><br />echo </span><span style="color: #DD0000">"Old Session: </span><span style="color: #0000BB">$old_sessionid</span><span style="color: #DD0000"><br />"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"New Session: </span><span style="color: #0000BB">$new_sessionid</span><span style="color: #DD0000"><br />"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$_SESSION</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.session-regenerate-id.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.session-id.php" class="function" rel="rdfs-seeAlso">session_id()</a> - Get and/or set the current session id</li>
<li class="member"><a href="function.session-start.php" class="function" rel="rdfs-seeAlso">session_start()</a> - Initialize session data</li>
<li class="member"><a href="function.session-name.php" class="function" rel="rdfs-seeAlso">session_name()</a> - Get and/or set the current session name</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
