File: session-unset.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (68 lines) | stat: -rw-r--r-- 1,752 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<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>void</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.void;
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <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>
  <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>
 </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
-->