array_unshift

(PHP 4, PHP 5, PHP 7, PHP 8)

array_unshift — Fügt ein oder mehr Elemente am Anfang eines Arrays ein

Beschreibung

array_unshift(array &$array, mixed ...$values): int

array_unshift() fügt die übergebenen Elemente am Anfang von array ein. Beachten Sie, dass die Liste von Elementen als Ganzes eingefügt wird, sodass die eingefügten Elemente ihre Reihenfolge behalten. Die numerischen Schlüssel werden so modifiziert, dass sie bei Null beginnen, während String-Schlüssel unverändert bleiben.

Hinweis:
Setzt den internen Zeiger des Arrays auf das erste Element zurück.

Parameter-Liste

array: Das Eingabe-Array.
values: Die einzufügenden Werte.

Rückgabewerte

Gibt die neue Anzahl der in array enthaltenen Elemente zurück.

Changelog

Version	Beschreibung
7.3.0	Diese Funktion kann nun mit nur einem Parameter aufgerufen werden. Zuvor waren mindestens zwei Parameter erforderlich.

Beispiele

Beispiel #1 array_unshift()-Beispiel

<?php
$queue = [
    "Orange",
    "Banane"
];

array_unshift($queue, "Apfel", "Himbeere");
var_dump($queue);
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

array(4) {
  [0] =>
  string(5) "Apfel"
  [1] =>
  string(8) "Himbeere"
  [2] =>
  string(6) "Orange"
  [3] =>
  string(6) "Banane"
}

Beispiel #2 Verwendung mit assoziativen Arrays

Wenn ein assoziatives Array einem anderen assoziativen Array vorangestellt wird, wird das vorangestellte Array numerisch in das vorherige Array indiziert.

<?php
$lebensmittel = [
    'Äpfel' => [
        'McIntosh' => 'rot',
        'Granny Smith' => 'grün',
    ],
    'Orangen' => [
        'Navel' => 'orange',
        'Valencia' => 'orange',
    ],
];
$gemuese = [
    'Salat' => [
        'Eisberg' => 'grün',
        'Butterkopf' => 'grün',
    ],
    'Möhren' => [
        'Dunkellila Hybrid' => 'lila',
        'Imperator' => 'orange',
    ],
    'Gurken' => [
        'Kirby' => 'grün',
        'Gherkin' => 'grün',
    ],
];

array_unshift($lebensmittel, $gemuese);
var_dump($lebensmittel);

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

array(3) {
  [0] =>
  array(3) {
    'Salat' =>
    array(2) {
      'Eisberg' =>
      string(4) "grün"
      'Butterkopf' =>
      string(4) "grün"
    }
    'Möhren' =>
    array(2) {
      'Dunkellila Hybrid' =>
      string(4) "lila"
      'Imperator' =>
      string(6) "orange"
    }
    'Gurken' =>
    array(2) {
      'Kirby' =>
      string(4) "grün"
      'Gherkin' =>
      string(4) "grün"
    }
  }
  'Äpfel' =>
  array(2) {
    'McIntosh' =>
    string(3) "rot"
    'Granny Smith' =>
    string(4) "grün"
  }
  'Orangen' =>
  array(2) {
    'Navel' =>
    string(6) "orange"
    'Valencia' =>
    string(6) "orange"
  }
}

Siehe auch

array_merge() - Führt zwei oder mehr Arrays zusammen
array_shift() - Liefert und entfernt das erste Element eines Arrays
array_push() - Fügt ein oder mehr Elemente an das Ende eines Arrays an
array_pop() - Liefert und entfernt das letzte Element eines Arrays