array_shift

(PHP 4, PHP 5, PHP 7, PHP 8)

array_shiftDespila un elemento al principio de un array

Descripción

array_shift(array &$array): mixed

array_shift() extrae el primer valor del array array y lo devuelve, acortando array en un elemento, y desplazando todos los elementos hacia abajo. Todas las claves numéricas serán modificadas para comenzar en cero mientras que las claves literales no serán afectadas.

Nota: Esta función ejecutará un reset() en el puntero de array del array de entrada después de su uso.

Parámetros

array

El array de entrada.

Valores devueltos

Devuelve el valor despilado, o null si el array está vacío o si el valor de entrada no es un array.

Ejemplos

Ejemplo #1 Ejemplo con array_shift()

<?php
$stack
= array("orange", "banana", "apple", "raspberry");
$fruit = array_shift($stack);
print_r($stack);
?>

El resultado del ejemplo sería:

Array
(
    [0] => banana
    [1] => apple
    [2] => raspberry
)

y orange ha sido colocado en $fruit.

Ver también