array_shift

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

array_shift — Retira o primeiro elemento de um array

Descrição

array_shift(array &$array): mixed

array_shift() retira o primeiro elemento de array e o retorna, diminuindo array em um elemento e movendo todos os outros elementos para trás. Todas as chaves numéricas serão alteradas para começar a contar a partir de zero, enquanto chaves literais não serão afetadas.

Note: Após o uso desta função, assim como na função reset(), o ponteiro interno do array fornecido apontará para o primeiro elemento.

Parâmetros

array

O array de entrada.

Valor Retornado

Retorna o valor removido, ou null se array for vazio ou não é um array.

Exemplos

Example #1 Exemplo da array_shift()

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

O exemplo acima produzirá:

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

e orange seria passado para $fruit.

Veja Também