function.array-unshift.html

<HTML
><HEAD
><TITLE
>array_unshift</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="Array Functions"
HREF="ref.array.html"><LINK
REL="PREVIOUS"
TITLE="array_unique"
HREF="function.array-unique.html"><LINK
REL="NEXT"
TITLE="array_values"
HREF="function.array-values.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.array-unique.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.array-values.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.array-unshift"
>array_unshift</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN4998"
></A
><P
>    (PHP4 )</P
>array_unshift&nbsp;--&nbsp;
     Push one or more elements onto the beginning of array
    </DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN5001"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN5003"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="function"
>array_unshift</B
></CODE
> (array array, mixed var [, mixed
       ...])</CODE
></P
><P
></P
></DIV
><P
>&#13;     <B
CLASS="function"
>Array_unshift()</B
> prepends passed elements to
     the front of the <TT
CLASS="parameter"
><I
>array</I
></TT
>. Note that the list
     of elements is prepended as a whole, so that the prepended
     elements stay in the same order.
    </P
><P
>&#13;     Returns the new number of elements in the
     <TT
CLASS="parameter"
><I
>array</I
></TT
>.
    </P
><P
>&#13;     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN5020"
></A
><P
><B
>Example 1. <B
CLASS="function"
>Array_unshift()</B
> example</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
>&#13;$queue = array ("p1", "p3");
array_unshift ($queue, "p4", "p5", "p6");
      </PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
    </P
><P
>&#13;     This would result in <TT
CLASS="varname"
>$queue</TT
> having 5
     elements: "p4", "p5", "p6", "p1", and "p3".
    </P
><P
>&#13;     See also <A
HREF="function.array-shift.html"
><B
CLASS="function"
>array_shift()</B
></A
>,
     <A
HREF="function.array-push.html"
><B
CLASS="function"
>array_push()</B
></A
>, and
     <A
HREF="function.array-pop.html"
><B
CLASS="function"
>array_pop()</B
></A
>.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.array-unique.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.array-values.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>array_unique</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.array.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>array_values</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>