array_shift

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

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

説明

array_shift(array &$array): mixed

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

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

パラメータ

array

入力の配列。

戻り値

取り出した値を返します。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 が代入されます。

参考

  • array_unshift() - 一つ以上の要素を配列の最初に加える
  • array_push() - 一つ以上の要素を配列の最後に追加する
  • array_pop() - 配列の末尾から要素を取り除く

関連キーワード:  配列, array, 要素, 一つ, 先頭, 関数, 最初, 入力, キー, fruit