PHP array_unshift() Function

Complete PHP Array Reference

Example

Insert the element "blue" into the array:

<?php
$a=array("a"=>"red","b"=>"green");
array_unshift($a,"blue");
print_r($a);
?>

Run Example Β»


Definition and Usage

The array_unshift() function inserts new elements to the beginning of an array. The new array values will be inserted in the beginning of the array.

Tip: You can insert one or more values.

Note: Numeric keys will start at 0 and increase by 1. String keys will remain unchanged.


Syntax

array_unshift(array,value1,value2,value3...)
Parameter Description
array Required. Specifies the array.
value1 Required. Specifies the value to insert.
value2 Optional. Specifies the value to insert.
value3 Optional. Specifies the value to insert.

Technical Details

Return Value: Returns the new number of elements in the array.
PHP Version: 4+

More Examples

Example 1

Show the return value:

<?php
$a=array("a"=>"red","b"=>"green");
print_r(array_unshift($a,"blue"));
?>

Run Example Β»

Example 2

Using numeric keys:

<?php
$a=array(0=>"red",1=>"green");
array_unshift($a,"blue");
print_r($a);
?>

Run Example Β»


Complete PHP Array Reference