<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry xml:id="function.array-shift" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_shift</refname>
  <refpurpose>Shift an element off the beginning of array</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>mixed</type><methodname>array_shift</methodname>
   <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_shift</function> shifts the first value of the
   <parameter>array</parameter> off and returns it, shortening the
   <parameter>array</parameter> by one element and moving everything
   down. All numerical array keys will be modified to start counting from zero
   while literal keys won't be touched. If <parameter>array</parameter> is empty
   (or is not an array), &null; will be returned.
  </para>

  &array.resetspointer;

  <example>
   <title><function>array_shift</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$stack = array("orange", "banana", "apple", "raspberry");
$fruit = array_shift($stack);
print_r($stack);
?>
]]>
   </programlisting>
   <para>
    This would result in <varname>$stack</varname> having 3 elements left:
   </para>
   <screen role="php">
<![CDATA[
Array
(
    [0] => banana
    [1] => apple
    [2] => raspberry
)
]]>
   </screen>
   <para>
    and <literal>orange</literal> will be assigned to
    <varname>$fruit</varname>.
   </para>
  </example>
  <para>
   See also <function>array_unshift</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
-->