php-doc-en/reference/session/functions/session-regenerate-id.xml
2003-12-15 16:55:22 +00:00

80 lines
1.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.session-regenerate-id">
<refnamediv>
<refname>session_regenerate_id</refname>
<refpurpose>
Update the current session id with a newly generated one
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>session_regenerate_id</methodname>
<void />
</methodsynopsis>
<para>
<function>session_regenerate_id</function> will replace the current
session id with a new one, and keep the current session information.
</para>
<para>
&return.success;
</para>
<para>
<example>
<title>A <function>session_regenerate_id</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
session_start();
$old_sessionid = session_id();
session_regenerate_id();
$new_sessionid = session_id();
echo "Old Session: $old_sessionid<br />";
echo "New Session: $new_sessionid<br />";
print_r($_SESSION);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
As of PHP 4.3.3, if session cookies are enabled, use of
<function>session_regenerate_id</function> will also submit a new
session cookie with the new session id.
</para>
</note>
<para>
See also <function>session_id</function>,
<function>session_start</function>, and
<function>session_name</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->