<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry id="function.array-unshift">
 <refnamediv>
  <refname>array_unshift</refname>
  <refpurpose>Prepend one or more elements to the beginning of an array</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>int</type><methodname>array_unshift</methodname>
   <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_unshift</function> prepends passed elements to
   the front of the <parameter>array</parameter>. Note that the list
   of elements is prepended as a whole, so that the prepended
   elements stay in the same order.  All numerical array keys will be
   modified to start counting from zero while literal keys won't be touched.
  </para>
  <para>
   Returns the new number of elements in the
   <parameter>array</parameter>.
  </para>
  <para>
   <example>
    <title><function>array_unshift</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$queue = array("orange", "banana");
array_unshift($queue, "apple", "raspberry");
print_r($queue);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
Array
(
    [0] => apple
    [1] => raspberry
    [2] => orange
    [3] => banana
)
]]>
    </screen>
   </example>
  </para>
  <para>
   See also <function>array_shift</function>,
   <function>array_push</function>, and
   <function>array_pop</function>.
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->