<!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>Push one or more elements onto 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-product.html">array_product</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.array-rand.html">array_rand</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-push" class="refentry">
<div class="refnamediv">
<h1 class="refname">array_push</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">array_push</span> — <span class="dc-title">Push one or more elements onto the end of array</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.array-push-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>array_push</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$array</code></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">$...</code></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>array_push()</strong></span> treats <code class="parameter">array</code> as a
stack, and pushes the passed variables onto the end of
<code class="parameter">array</code>. The length of <code class="parameter">array</code>
increases by the number of variables pushed. Has the same effect as:
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$array</span><span style="color: #007700">[] = </span><span style="color: #0000BB">$var</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
repeated for each passed value.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
If you use <span class="function"><strong>array_push()</strong></span> to add one element to the
array, it's better to use <em>$array[] = </em> because in that
way there is no overhead of calling a function.
</span>
</p></blockquote>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
<span class="function"><strong>array_push()</strong></span> will raise a warning if the first
argument is not an array. This differs from the
<em>$var[]</em> behaviour where a new array is created.
</span>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.array-push-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">array</code></dt>
<dd>
<p class="para">
The input array.
</p>
</dd>
<dt>
<code class="parameter">...</code></dt>
<dd>
<p class="para">
The values to push onto the end of the <code class="parameter">array</code>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.array-push-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the new number of elements in the array.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.array-push-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>7.3.0</td>
<td>
This function can now be called with only one parameter. Formerly, at
least two parameters have been required.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.array-push-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-6187">
<p><strong>Example #1 <span class="function"><strong>array_push()</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">);<br /></span><span style="color: #0000BB">array_push</span><span style="color: #007700">(</span><span style="color: #0000BB">$stack</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">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>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[0] => orange
[1] => banana
[2] => apple
[3] => raspberry
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.array-push-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.array-pop.html" class="function" rel="rdfs-seeAlso">array_pop()</a> - Pop the element off 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-product.html">array_product</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.array-rand.html">array_rand</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>
