PHP array_push(): добавление элементов в массив

array_push($arr, $value) добавляет значение в конец массива. Для одного значения сокращение $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[] =

Для одного значения используйте $arr[] = $value: это короче и обходится без вызова функции, что заметно в большом цикле. 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 как один вложенный элемент, а это редко то, что нужно. Чтобы добавить значения $b по одному, распакуйте их или соберите новый массив через синтаксис распаковки или 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() и sort(), которая возвращает true. Функции, которые меняют массив на месте, возвращают статус, а не массив.