array_shift
PHP function
Edit on GitHub ✎
(PHP 4, PHP 5, PHP 7, PHP 8)
Shift an element off the beginning of array
Description
array_shift(array $array): mixed
array_shift() shifts the first value of the array off and returns it, shortening the array 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 affected.
Resetspointer
Parameters
arrayThe input array.
Return Values
Returns the shifted value, or null if array is empty or is not an array.
Examples
array_shift() example
php
<?php
$stack = array("orange", "banana", "apple", "raspberry");
$fruit = array_shift($stack);
print_r($stack);
?>The above example will output:
output
Array
(
[0] => banana
[1] => apple
[2] => raspberry
)and orange will be assigned to $fruit.