array_unshift() - 配列の先頭に要素を追加する

公開日: 2016/12/18

array_unshiftは、配列の先頭に要素を追加する関数です。この関数は、元の配列を変更します。キーが数値の場合、0から振り直しされます。

構文

int array_unshift ( array &$array , mixed $value1 [, mixed $... ] )

パラメータ

&$array

元の配列。

$value1

先頭に追加する要素。

$...

第3引数以降を指定した場合、第2引数が配列の[0](先頭)、第3引数が[1]、第4引数が[2]…というように追加される。

返り値

int

先頭に要素を追加した後の、配列の要素数。

サンプルコード

返り値は要素数

返り値は、要素を追加した後の配列の要素数です。

php

<?php
	// 元の配列
	$queue = [ "b", "c", "d" ] ;

	// 実行
	$result = array_unshift( $queue, "A" ) ;

	// 返り値
	var_dump( $result ) ;

結果 (出力内容) - PHP7.0.21

int(4)

変更後の配列

array_unshiftは、引数に指定した元の配列に変更を加えます。

php

<?php
	// 元の配列
	$queue = [ "b", "c", "d" ] ;

	// 実行
	$result = array_unshift( $queue, "A" ) ;

	// 配列の内容
	var_dump( $queue ) ;

結果 (出力内容) - PHP7.0.21

array(4) {
  [0]=>
  string(1) "A"
  [1]=>
  string(1) "b"
  [2]=>
  string(1) "c"
  [3]=>
  string(1) "d"
}

第3引数以降を指定

第3引数以降を指定できます。この場合、第2引数、第3引数、第4引数…といった順番で先頭に追加されます。

php

<?php
	// 元の配列
	$queue = [ "b", "c", "d" ] ;

	// 実行
	$result = array_unshift( $queue, "A", "B", "C" ) ;

	// 配列の内容
	var_dump( $queue ) ;

結果 (出力内容) - PHP7.0.21

array(6) {
  [0]=>
  string(1) "A"
  [1]=>
  string(1) "B"
  [2]=>
  string(1) "C"
  [3]=>
  string(1) "b"
  [4]=>
  string(1) "c"
  [5]=>
  string(1) "d"
}

サンドボックス

ソースコードを編集してarray_unshift()の挙動を確認して下さい。

CODE
RUN

array(6) {
  [0]=>
  string(1) "A"
  [1]=>
  string(1) "a"
  [2]=>
  string(1) "b"
  [3]=>
  string(1) "c"
  [4]=>
  string(1) "d"
  [5]=>
  string(1) "e"
}

参考リンク

PHP - 公式マニュアル。