array_unshift
(PHP 4, PHP 5, PHP 7, PHP 8)
array_unshift — Prepend one or more elements to the beginning of an array
Description
array_unshift() prepends passed elements to the front
of the array
. 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 changed.
Note:
Resets array's internal pointer to the first element.
Parameters
-
array
-
The input array.
-
values
-
The values to prepend.
Return Values
Returns the new number of elements in the array
.
Changelog
Version | Description |
---|---|
7.3.0 | This function can now be called with only one parameter. Formerly, at least two parameters have been required. |
Examples
Example #1 array_unshift() example
<?php
$queue = array("orange", "banana");
array_unshift($queue, "apple", "raspberry");
print_r($queue);
?>
The above example will output:
Array ( [0] => apple [1] => raspberry [2] => orange [3] => banana )
See Also
- array_shift() - Shift an element off the beginning of array
- array_push() - Push one or more elements onto the end of array
- array_pop() - Pop the element off the end of array