array_unshift - 配列の先頭に要素を追加する
array_unshiftは、配列の先頭に要素を追加する関数です。この関数は、元の配列を変更します。キーが数値の場合、0から振り直しされます。
構文
パラメータ
&$array
元の配列。
$value1
先頭に追加する要素。
$...
第3引数以降を指定した場合、第2引数が配列の[0](先頭)、第3引数が[1]、第4引数が[2]…というように追加される。
返り値
int
先頭に要素を追加した後の、配列の要素数。
サンプルコード
<?php
$array = [ "b", "c", "d" ] ;
$response = array_unshift( $array, "A" ) ;
デモ
返り値は要素数
返り値は、要素を追加した後の配列の要素数です。
<?php
/*** このコードは編集できます。 ***/
$array = [ "b", "c", "d" ] ;
$response = array_unshift( $array, "A" ) ;
var_dump( $response ) ;
echo "<BR>" ;
var_dump( $array ) ;
変更後の配列
array_unshiftは、引数に指定した元の配列に変更を加えます。
<?php
/*** このコードは編集できます。 ***/
$array = [ "b", "c", "d" ] ;
$response = array_unshift( $array, "A" ) ;
var_dump( $response ) ;
echo "<BR>" ;
var_dump( $array ) ;
第3引数以降を指定
第3引数以降を指定できます。この場合、第2引数、第3引数、第4引数…といった順番で先頭に追加されます。
<?php
/*** このコードは編集できます。 ***/
$array = [ "b", "c", "d" ] ;
$response = array_unshift( $array, "A", "B", "C" ) ;
var_dump( $response ) ;
echo "<BR>" ;
var_dump( $array ) ;
参考
- PHP: array_unshift
- PHPの公式リファレンス。
関連記事
- array_unique
- 配列から重複した値を削除する。
- array_rand
- 配列から1つ以上の値をランダムに取得する。
- array_multisort
- 複数、多次元の配列をソートする。
- array_merge_recursive
- 複数の配列を再帰的にマージする。
- array_push
- 配列の末尾に要素を追加する。
- array_shift
- 配列の先頭の要素を取り除く。