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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
<?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="parameters">
&reftitle.parameters;
&no.function.parameters;
</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.
<code>unset($_SESSION['varname']);</code>.
</para>
</note>
<caution>
<para>
Do NOT unset the whole <varname>$_SESSION</varname> with
<code>unset($_SESSION)</code> as this will disable the registering
of session variables through the <varname>$_SESSION</varname> superglobal.
</para>
</caution>
<note>
<para>
The use of <function>session_unset</function> is identical to <code>$_SESSION = []</code>.
</para>
</note>
<caution>
<para>
This function works only if a session is active. It will not clear the
<varname>$_SESSION</varname> array if the session has not been started yet
or has already been destroyed. Use <code>$_SESSION = []</code> to unset all
session variables even if the session is not active.
</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:"~/.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
-->
|
