php-doc-en/reference/session/functions/session-unset.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/session.xml, last change in rev 1.8 -->
<refentry id="function.session-unset">
 <refnamediv>
  <refname>session_unset</refname>
  <refpurpose>Free all session variables</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>void</type><methodname>session_unset</methodname>
   <void/>
  </methodsynopsis>
  <para>
   The <function>session_unset</function> function frees all session variables
   currently registered.
  </para>
  <note>
   <para>
    If <varname>$_SESSION</varname> (or
    <varname>$HTTP_SESSION_VARS</varname> for PHP 4.0.6 or less) is
    used, use <function>unset</function> to unregister a session
    variable, i.e. <literal>unset ($_SESSION['varname']);</literal>.
   </para>
  </note>
  <para>
   <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>
  </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
-->