PHPで配列に追加：array_push()と$arr[]の使い方

array_push($arr, $value)は配列の末尾に値を追加します。値が1つなら、短縮形の$arr[] = $value;が関数を呼ばずに同じことをし、ほとんどのPHPのコードはこちらを使います。どちらも配列をその場で変更します。

<?php
$colors = ['red', 'green'];

$colors[] = 'blue';                    // shorthand, one value
array_push($colors, 'yellow', 'pink'); // several values at once

print_r($colors);

array_push()は配列を参照で受け取るので、渡した変数を変更します。戻り値は新しい要素数で、無視してかまいません。

array_pushと$arr[] =の違い

値が1つなら$arr[] = $valueを使います。短く、関数の呼び出しも省けるので、大きなループの中では差が積み重なります。1つの文で複数の値を追加するときや、値のリストを展開して入れるときはarray_push()を使います。

<?php
$log = [];
for ($i = 1; $i <= 3; $i++) {
    $log[] = "step $i";
}

$more = ['step 4', 'step 5'];
$count = array_push($log, ...$more);   // spread a list in

print_r($log);
echo "Now $count entries\n";

$arr[] =はまだ存在しない変数にも使え、PHPが配列を作ります。array_push()には既存の配列が必要で、未定義の変数に使うとTypeError: array_push(): Argument #1 ($array) must be of type array, null givenが投げられます。

キーと値を追加する

array_push()は次の整数キーで値を追加することしかできません。名前付きのキーを追加するには、そのキーに代入します。複数のペアを一度に追加するには、+=（既存のキーを保つ）かarray_merge()（新しい値が優先）を使います。

<?php
$user = ['name' => 'Ada'];

$user['email'] = 'ada@example.com';             // one key and value
$user += ['role' => 'admin', 'name' => 'X'];    // adds role; name already exists, kept

print_r($user);

array_push($user, 'oops');                      // gets key 0, not a name
print_r($user);

キーがぶつかったときの+とarray_merge()の違いは、array_mergeのページで扱っています。

先頭に追加する：array_unshift

array_unshift($arr, $value)は先頭に挿入します。新しい値が添字0になるよう整数キーの番号が振り直され、文字列キーはそのままです。array_push()と同じく、複数の値を受け取り、新しい要素数を返します。

<?php
$queue = ['Linus', 'Grace'];
array_unshift($queue, 'Ada');
print_r($queue);

$menu = ['home' => '/', 'about' => '/about'];
array_unshift($menu, '/login');      // string keys are kept, the new value gets key 0
print_r($menu);

名前付きのペアを先頭に置くには、新しい配列を作ります：$menu = ['login' => '/login'] + $menu;。

指定した位置に挿入する

array_splice($arr, $offset, 0, $values)は何も削除せずに挿入します。$offsetから始めて0個の要素を削除し、そこに新しい値を置きます。挿入位置より後ろの整数キーは番号が振り直されます。

<?php
$letters = ['a', 'b', 'd', 'e'];

array_splice($letters, 2, 0, 'c');           // insert 'c' at index 2
print_r($letters);

array_splice($letters, 1, 0, ['x', 'y']);    // insert two values at index 1
echo implode(' ', $letters), "\n";

array_splice()は要素の削除や置き換えにも使えます。それらの形は要素を削除するページで紹介しています。

別の配列を追加する

array_push($a, $b)は$bを1つのネストした要素として追加しますが、これが望みであることはまれです。$bの値を1つずつ追加するには展開するか、スプレッド構文やarray_merge()で新しい配列を作ります。

<?php
$a = [1, 2];
$b = [3, 4];

$nested = $a;
array_push($nested, $b);       // [1, 2, [3, 4]]
echo json_encode($nested), "\n";

$flat = $a;
array_push($flat, ...$b);      // [1, 2, 3, 4]
echo json_encode($flat), "\n";

echo json_encode([...$a, ...$b]), "\n";

よくあるミス：戻り値を代入する

array_push()は数値、つまり新しい要素数を返します。それを配列の変数に代入し直すと配列が整数に置き換わり、次にその変数でarray_push()を呼ぶとTypeErrorが投げられます。

<?php
$items = ['pen', 'book'];

$result = array_push($items, 'lamp');
var_dump($result);    // the count, not the array

// Wrong: $items = array_push($items, 'mug');  turns $items into int(4)
array_push($items, 'mug');   // right: call it on its own line
print_r($items);

同じことがarray_unshift()と、trueを返すsort()にも当てはまります。配列をその場で変更する関数は、配列ではなく状態を返します。