array_shift

(PHP 4, PHP 5)

array_shift — 配列の先頭から要素を一つ取り出す

mixed array_shift ( array &$array )

array_shift() は、array の最初の値を取り出して返します。配列 array は、要素一つ分だけ短くなり、全ての要素は前にずれます。数値添字の配列のキーはゼロから順に新たに振りなおされますが、リテラルのキーはそのままになります。

注意: この関数は、入力配列のポインタを、使用した後にリセット (reset()) します。

取り出した値を返します。array が空の場合や配列でない場合は NULL を返します。

例1 array_shift() の例


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

上の例の出力は以下となります。

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

そして、$fruit には orange が代入されます。