array_unshift

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

array_unshift一つ以上の要素を配列の最初に加える

説明

array_unshift(array &$array, mixed ...$values): int

array_unshift() は、array の先頭に指定された要素を加えます。リストの要素は全体として加えられるため、 加えられた要素の順番は変わらないことに注意してください。 配列の数値添字はすべて新たにゼロから振りなおされます。 リテラルのキーについては変更されません。

注意:

この関数をコールすると、配列の内部ポインタは最初の要素にリセットされます。

パラメータ

array

入力の配列。

values

加える値。

戻り値

処理後の array の要素の数を返します。

変更履歴

バージョン 説明
7.3.0 この関数は、1 つのパラメータでのみ呼び出すことができるようになりました。 前は、少なくとも 2 つのパラメータが必要でした。

例1 array_unshift() の例

<?php
$queue 
= array("orange""banana");
array_unshift($queue"apple""raspberry");
print_r($queue);
?>

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

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

参考

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

関連キーワード:  要素, array, 配列, 一つ, 最初, unshift, パラメータ, values, 関数, 注意