PHP array_push(): Elemente zu einem Array hinzufügen

array_push($arr, $value) fügt einen Wert am Ende eines Arrays hinzu. Für einen einzelnen Wert erledigt die Kurzform $arr[] = $value; dieselbe Aufgabe ohne Funktionsaufruf, und die meisten PHP-Codebasen verwenden sie. Beide ändern das Array direkt.

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

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

print_r($colors);

array_push() nimmt das Array per Referenz, ändert also die Variable, die du übergibst. Es liefert die neue Anzahl der Elemente zurück, die du ignorieren kannst.

array_push vs $arr[] =

Verwende $arr[] = $value für einen Wert: Es ist kürzer und spart einen Funktionsaufruf, was sich in einer großen Schleife summiert. Verwende array_push(), wenn du mehrere Werte in einer Anweisung hinzufügen oder eine Liste von Werten hineinspreaden willst.

<?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[] = funktioniert auch bei einer Variable, die noch nicht existiert: PHP erzeugt das Array. array_push() braucht ein bestehendes Array: Bei einer undefinierten Variable wirft es TypeError: array_push(): Argument #1 ($array) must be of type array, null given.

Einen Schlüssel mit Wert hinzufügen

array_push() hängt Werte nur mit dem nächsten Ganzzahl-Schlüssel an. Um einen benannten Schlüssel hinzuzufügen, weist du ihm etwas zu. Um mehrere Paare auf einmal hinzuzufügen, verwendest du += (behält bestehende Schlüssel) oder array_merge() (lässt die neuen Werte gewinnen).

<?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);

Den Unterschied zwischen + und array_merge() bei kollidierenden Schlüsseln behandelt die Seite zu array_merge.

Am Anfang hinzufügen: array_unshift

array_unshift($arr, $value) fügt am Anfang ein. Ganzzahl-Schlüssel werden neu nummeriert, sodass der neue Wert den Index 0 bekommt; String-Schlüssel bleiben, wie sie sind. Wie array_push() nimmt es mehrere Werte an und liefert die neue Anzahl zurück.

<?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);

Um ein benanntes Paar an den Anfang zu setzen, baust du ein neues Array: $menu = ['login' => '/login'] + $menu;.

An einer bestimmten Position einfügen

array_splice($arr, $offset, 0, $values) fügt ein, ohne etwas zu entfernen: Es beginnt bei $offset, entfernt 0 Elemente und setzt die neuen Werte dort ein. Die Ganzzahl-Schlüssel nach der Einfügestelle werden neu nummeriert.

<?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() kann auch Elemente entfernen und ersetzen; die Seite zum Entfernen von Elementen zeigt diese Formen.

Ein anderes Array anhängen

array_push($a, $b) fügt $b als ein einziges verschachteltes Element hinzu, was selten gewollt ist. Um die Werte von $b einzeln hinzuzufügen, spreadest du sie, oder du baust ein neues Array mit der Spread-Syntax oder 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";

Typischer Fehler: den Rückgabewert zuweisen

array_push() liefert eine Zahl, die neue Anzahl der Elemente. Wenn du sie der Array-Variable zuweist, ersetzt du dein Array durch eine Ganzzahl, und das nächste array_push() darauf wirft einen 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);

Dasselbe gilt für array_unshift() und für sort(), das true liefert. Funktionen, die ein Array direkt ändern, geben einen Status zurück, nicht das Array.