array_shift

(PHP 4 , PHP 5)

array_shift --  Retira o primeiro elemento de um array

Descrição

mixed array_shift ( array array )

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 alteradas para começar a contar a de 0 (zero), enquanto chaves string permanecerão inalteradas. Se array estiver vazio (ou se não for um array), o valor NULL é retornado.

Nota: Esta função irá resetar() o ponteiro do array depois do uso.

Exemplo 1. Exemplo de array_shift()

<?php
$cesta
= array("laranja", "banana", "melancia", "morango");
$fruta = array_shift($cesta);
print_r($cesta);
?>

O programa acima resultaria em $stack tendo 3 elementos:

Array
(
    [0] => banana
    [1] => melancia
    [2] => morango
)

e laranja seria passado para $fruta.

Veja também array_unshift(), array_push() e array_pop().