mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
2a33bc5537
https://bugs.php.net/bug.php?id=77437 Submitted by girgias git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346785 c90b9560-bf6c-de11-be94-00142212c4b1
96 lines
2.3 KiB
XML
96 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-unset">
|
|
<refnamediv>
|
|
<refname>session_unset</refname>
|
|
<refpurpose>Free all session variables</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>session_unset</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
The <function>session_unset</function> function frees all session variables
|
|
currently registered.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>7.2.0</entry>
|
|
<entry>
|
|
The return type of this function is <type>bool</type> now.
|
|
Formerly, it has been <type>void</type>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
If <varname>$_SESSION</varname> is used, use <function>unset</function> to
|
|
unregister a session variable, i.e.
|
|
<literal>unset ($_SESSION['varname']);</literal>.
|
|
</para>
|
|
</note>
|
|
<caution>
|
|
<para>
|
|
Do NOT unset the whole <varname>$_SESSION</varname> with
|
|
<literal>unset($_SESSION)</literal> as this will disable the registering
|
|
of session variables through the <varname>$_SESSION</varname> superglobal.
|
|
</para>
|
|
</caution>
|
|
<note>
|
|
<para>
|
|
Only use <function>session_unset</function> for older deprecated code
|
|
that does not use <varname>$_SESSION</varname>.
|
|
</para>
|
|
</note>
|
|
</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:"~/.phpdoc/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
|
|
-->
|