Wendet eine vom Benutzer gelieferte Funktion auf jedes Element eines Arrays an

Beschreibung

array_walk(array|object &$array, callable $callback, mixed $arg = null): bool

Wendet die mittels callback angegebene Benutzerfunktion auf jedes Element von array an.

array_walk() ist nicht von dem internen Arrayzeiger von array betroffen. array_walk() geht ungeachtet der Zeigerposition das gesamte Array durch.

Parameter-Liste

array

Das Eingabe-Array.

callback

Typischerweise akzeptiert callback zwei Parameter. Der Wert von array wird als erster übergeben, und der Schlüssel/Index als zweiter.

Hinweis:
Wenn callback direkt mit den Werten des Arrays arbeiten soll, muss der erste Parameter von callback als Referenz spezifiziert werden. Dann werden alle Änderungen an diesen Elementen direkt in dem originalen Array durchgeführt.

Hinweis:
Viele interne Funktionen (z. B. strtolower()) erzeugen eine Warnung, wenn mehr als die erwartete Anzahl von Parametern übergeben wird; sie sind auch nicht direkt nutzbar als callback.

Nur die Werte von array können geändert werden. Die Struktur des Arrays kann nicht geändert werden, d. h. dass der Programmierer keine Elemente hinzufügen oder löschen kann und dass die Reihenfolge der Elemente nicht geändert werden kann. Falls die Callback-Funktion diese Anforderung nicht beachtet, ist das Verhalten dieser Funktion nicht definiert und auch nicht vorhersagbar.

arg

Wenn der optionale Parameter arg angegeben ist, wird er dem Callback callback als dritter Parameter übergeben.

Rückgabewerte

Gibt true zurück.

Fehler/Exceptions

Von PHP 7.1.0 an wird ein ArgumentCountError ausgelöst, wenn die callback-Funktion mehr als 2 Parameter benötigt (der Wert und Schlüssel des Array-Elements), oder mehr als 3 Parameter, wenn arg ebenfalls übergeben wird. Zuvor wurde, falls die callback-Funktion mehr als 2 Parameter benötigte, bei jedem Aufruf von callback durch array_walk() eine Fehlermeldung der Stufe E_WARNING generiert.

Changelog

Version	Beschreibung
8.0.0	Wenn die `callback`-Funktion erwartet, dass der zweite oder dritte Parameter per Referenz übergeben wird, gibt diese Funktion nun einen Fehler der Stufe `E_WARNING` aus.

Beispiele

Beispiel #1 array_walk()-Beispiel

<?php
$fruits = array("d" => "Zitrone", "a" => "Orange", "b" => "Banane", "c" => "Apfel");

function test_alter(&$item1, $key, $prefix)
{
    $item1 = "$prefix: $item1";
}

function test_print($item2, $key)
{
    echo "$key. $item2\n";
}

echo "Vorher ...:\n";
array_walk($fruits, 'test_print');

array_walk($fruits, 'test_alter', 'Frucht');
echo "... und nachher:\n";

array_walk($fruits, 'test_print');
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Vorher ...:
d. Zitrone
a. Orange
b. Banane
c. Apfel
... und nachher:
d. Frucht: Zitrone
a. Frucht: Orange
b. Frucht: Banane
c. Frucht: Apfel

Beispiel #2 array_walk()-Beispiel mit einer anonymen Funktion

<?php
$elements = ['a', 'b', 'c'];

array_walk($elements, function ($value, $key) {
  echo "{$key} => {$value}\n";
});

?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

0 => a
1 => b
2 => c

Siehe auch

array_walk_recursive() - Wendet eine Benutzerfunktion rekursiv auf jedes Element eines Arrays an
iterator_apply() - Call a function for every element in an iterator
list() - Weist Variablen zu, als wären sie ein Array
each() - Liefert das aktuelle Schlüssel-Wert-Paar eines Arrays und rückt den Arrayzeiger vor
call_user_func_array() - Call a callback with an array of parameters
array_map() - Wendet eine Callback-Funktion auf die Elemente von Arrays an
foreach