<!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>Pop the element off the end of array</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.array-pad.html">array_pad</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.array-product.html">array_product</a></div> <div class="up"><a href="ref.array.html">Array Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.array-pop" class="refentry"> <div class="refnamediv"> <h1 class="refname">array_pop</h1> <p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">array_pop</span> — <span class="dc-title">Pop the element off the end of array</span></p> </div> <div class="refsect1 description" id="refsect1-function.array-pop-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>array_pop</strong></span> ( <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$array</code></span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>array_pop()</strong></span> pops and returns the value of the last element of <code class="parameter">array</code>, shortening the <code class="parameter">array</code> by one element. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This function will <span class="function"><a href="function.reset.html" class="function">reset()</a></span> the <span class="type"><a href="language.types.array.html" class="type array">array</a></span> pointer of the input array after use.</span></p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-function.array-pop-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">array</code></dt> <dd> <p class="para"> The array to get the value from. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.array-pop-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the value of the last element of <code class="parameter">array</code>. If <code class="parameter">array</code> is empty (or is not an array), <strong><code>NULL</code></strong> will be returned. </p> </div> <div class="refsect1 errors" id="refsect1-function.array-pop-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> This function will produce an error of level <a href="errorfunc.constants.html" class="link"> E_WARNING</a> when called on a non-array. </p> </div> <div class="refsect1 examples" id="refsect1-function.array-pop-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-6185"> <p><strong>Example #1 <span class="function"><strong>array_pop()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$stack </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"orange"</span><span style="color: #007700">, </span><span style="color: #DD0000">"banana"</span><span style="color: #007700">, </span><span style="color: #DD0000">"apple"</span><span style="color: #007700">, </span><span style="color: #DD0000">"raspberry"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$fruit </span><span style="color: #007700">= </span><span style="color: #0000BB">array_pop</span><span style="color: #007700">(</span><span style="color: #0000BB">$stack</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$stack</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p> After this, <var class="varname"><var class="varname">$stack</var></var> will have only 3 elements: </p></div> <div class="example-contents screen"> <div class="cdata"><pre> Array ( [0] => orange [1] => banana [2] => apple ) </pre></div> </div> <div class="example-contents"><p> and <em>raspberry</em> will be assigned to <var class="varname"><var class="varname">$fruit</var></var>. </p></div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.array-pop-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><span class="function"><a href="function.array-push.html" class="function" rel="rdfs-seeAlso">array_push()</a> - Push one or more elements onto the end of array</span></li> <li class="member"><span class="function"><a href="function.array-shift.html" class="function" rel="rdfs-seeAlso">array_shift()</a> - Shift an element off the beginning of array</span></li> <li class="member"><span class="function"><a href="function.array-unshift.html" class="function" rel="rdfs-seeAlso">array_unshift()</a> - Prepend one or more elements to the beginning of an array</span></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.array-pad.html">array_pad</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.array-product.html">array_product</a></div> <div class="up"><a href="ref.array.html">Array Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>