<!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>Removes a stored variable from the cache</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.apcu-dec.html">apcu_dec</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.apcu-entry.html">apcu_entry</a></div> <div class="up"><a href="ref.apcu.html">APCu Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.apcu-delete" class="refentry"> <div class="refnamediv"> <h1 class="refname">apcu_delete</h1> <p class="verinfo">(PECL apcu >= 4.0.0)</p><p class="refpurpose"><span class="refname">apcu_delete</span> — <span class="dc-title"> Removes a stored variable from the cache </span></p> </div> <div class="refsect1 description" id="refsect1-function.apcu-delete-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>apcu_delete</strong></span> ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$key</code></span> )</div> <p class="para rdfs-comment"> Removes a stored variable from the cache. </p> </div> <div class="refsect1 parameters" id="refsect1-function.apcu-delete-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">key</code></dt> <dd> <p class="para"> A <code class="parameter">key</code> used to store the value as a <span class="type"><a href="language.types.string.html" class="type string">string</a></span> for a single key, or as an <span class="type"><a href="language.types.array.html" class="type array">array</a></span> of strings for several keys, or as an <a href="class.apcuiterator.html" class="classname">APCUIterator</a> <span class="type"><a href="language.types.object.html" class="type object">object</a></span>. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.apcu-delete-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.apcu-delete-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-451"> <p><strong>Example #1 A <span class="function"><strong>apcu_delete()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$bar </span><span style="color: #007700">= </span><span style="color: #DD0000">'BAR'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">apcu_store</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">, </span><span style="color: #0000BB">$bar</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">apcu_delete</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// this is obviously useless in this form<br /><br />// Alternatively delete multiple keys.<br /></span><span style="color: #0000BB">apcu_delete</span><span style="color: #007700">([</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">, </span><span style="color: #DD0000">'baz'</span><span style="color: #007700">]);<br /><br /></span><span style="color: #FF8000">// Or use an Iterator with a regular expression.<br /></span><span style="color: #0000BB">apcu_delete</span><span style="color: #007700">(new </span><span style="color: #0000BB">APCUIterator</span><span style="color: #007700">(</span><span style="color: #DD0000">'#^myprefix_#'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.apcu-delete-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><span class="function"><a href="function.apcu-store.html" class="function" rel="rdfs-seeAlso">apcu_store()</a> - Cache a variable in the data store</span></li> <li class="member"><span class="function"><a href="function.apcu-fetch.html" class="function" rel="rdfs-seeAlso">apcu_fetch()</a> - Fetch a stored variable from the cache</span></li> <li class="member"><span class="function"><a href="function.apcu-clear-cache.html" class="function" rel="rdfs-seeAlso">apcu_clear_cache()</a> - Clears the APCu cache</span></li> <li class="member"><a href="class.apcuiterator.html" class="classname">APCUIterator</a></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.apcu-dec.html">apcu_dec</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.apcu-entry.html">apcu_entry</a></div> <div class="up"><a href="ref.apcu.html">APCu Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>