(PHP 4, PHP 5)

array_shiftShift an element off the beginning of array


mixed array_shift ( array &$array )

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 touched.

Note: This function will reset() the array pointer after use.



The input array.

Return Values

Returns the shifted value, or NULL if array is empty or is not an array.


Example #1 array_shift() example

= array("orange""banana""apple""raspberry");
$fruit array_shift($stack);

The above example will output:

    [0] => banana
    [1] => apple
    [2] => raspberry

and orange will be assigned to $fruit.

See Also

  • array_unshift() - Prepend one or more elements to the beginning of an array
  • array_push() - Push one or more elements onto the end of array
  • array_pop() - Pop the element off the end of array

Copyright © 2010-2023 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout