<!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="sessionhandlerinterface.close.html">SessionHandlerInterface::close</a></div> <div class="next" style="text-align: right; float: right;"><a href="sessionhandlerinterface.gc.html">SessionHandlerInterface::gc</a></div> <div class="up"><a href="class.sessionhandlerinterface.html">SessionHandlerInterface</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="sessionhandlerinterface.destroy" class="refentry"> <div class="refnamediv"> <h1 class="refname">SessionHandlerInterface::destroy</h1> <p class="verinfo">(PHP 5 >= 5.4.0)</p><p class="refpurpose"><span class="refname">SessionHandlerInterface::destroy</span> — <span class="dc-title">Destroy a session</span></p> </div> <div class="refsect1 description" id="refsect1-sessionhandlerinterface.destroy-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SessionHandlerInterface::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 <span class="function"><a href="function.session-regenerate-id.html" class="function">session_regenerate_id()</a></span> (with $destroy = <strong><code>TRUE</code></strong>), <span class="function"><a href="function.session-destroy.html" class="function">session_destroy()</a></span> and when <span class="function"><a href="function.session-decode.html" class="function">session_decode()</a></span> fails. </p> </div> <div class="refsect1 parameters" id="refsect1-sessionhandlerinterface.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-sessionhandlerinterface.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="sessionhandlerinterface.close.html">SessionHandlerInterface::close</a></div> <div class="next" style="text-align: right; float: right;"><a href="sessionhandlerinterface.gc.html">SessionHandlerInterface::gc</a></div> <div class="up"><a href="class.sessionhandlerinterface.html">SessionHandlerInterface</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>