<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Destroy a session</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sessionhandler.close.html">SessionHandler::close</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sessionhandler.gc.html">SessionHandler::gc</a></div>
<div class="up"><a href="class.sessionhandler.html">SessionHandler</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="sessionhandler.destroy" class="refentry">
<div class="refnamediv">
<h1 class="refname">SessionHandler::destroy</h1>
<p class="verinfo">(PHP 5 >= 5.4.0)</p><p class="refpurpose"><span class="refname">SessionHandler::destroy</span> — <span class="dc-title">Destroy a session</span></p>
</div>
<div class="refsect1 description" id="refsect1-sessionhandler.destroy-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SessionHandler::destroy</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$session_id</code></span>
)</div>
<p class="para rdfs-comment">
Destroys a session. Called by internally by PHP with <span class="function"><a href="function.session-regenerate-id.html" class="function">session_regenerate_id()</a></span> (assuming
the <em><code class="parameter">$destory</code></em> is set to <strong><code>TRUE</code></strong>, by <span class="function"><a href="function.session-destroy.html" class="function">session_destroy()</a></span> or when
<span class="function"><a href="function.session-decode.html" class="function">session_decode()</a></span> fails.
</p>
<p class="para">
This method wraps the internal PHP save handler defined in the
<a href="session.configuration.html#ini.session.save-handler" class="link">session.save_handler</a> ini setting that was set
before this handler was set by <span class="function"><a href="function.session-set-save-handler.html" class="function">session_set_save_handler()</a></span>.
</p>
<p class="para">
If this class is extended by inheritiance, calling the parent <em><code class="parameter">destroy</code></em> method will invoke the
wrapper for this method and therefor invoke the associated internal callback. This allows this method to be
overidden and or intercepted and filtered.
</p>
<p class="para">
For more information on what this method is expected to do, please refer to the documentation
at <span class="function"><a href="sessionhandlerinterface.destroy.html" class="function">SessionHandlerInterface::destroy()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-sessionhandler.destroy-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">session_id</code></em></span>
<dd>
<p class="para">
The session ID being destroyed.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-sessionhandler.destroy-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The return value (usually <strong><code>TRUE</code></strong> on success, <strong><code>FALSE</code></strong> on failure). Note this value is returned internally to PHP for processing.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sessionhandler.close.html">SessionHandler::close</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sessionhandler.gc.html">SessionHandler::gc</a></div>
<div class="up"><a href="class.sessionhandler.html">SessionHandler</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
