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.

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

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
$cesta = array("laranja", "banana", "melancia", "morango");
$fruta = array_shift($cesta);
print_r($cesta);
?>

O exemplo acima irá imprimir:

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

e laranja seria passado para $fruta.

Veja Também

array_unshift() - Adiciona um ou mais elementos no início de um array
array_push() - Adiciona um ou mais elementos no final de um array
array_pop() - Retira um elemento do final do array