It's worth nothing that array_walk can not be used to change keys in the array.
The function may be defined as (&$value, $key) but not (&$value, &$key).
Even though PHP does not complain/warn, it does not modify the key.
(PHP 4, PHP 5, PHP 7, PHP 8)
array_walk — Wendet eine vom Benutzer gelieferte Funktion auf jedes Element eines Arrays an
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.
arrayDas 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
callbackdirekt mit den Werten des Arrays arbeiten soll, muss der erste Parameter voncallbackals 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.
Gibt immer true zurück.
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.
| Version | Beschreibung |
|---|---|
| 8.2.0 |
Der Rückgabewert ist nun true vorher war es bool.
|
| 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.
|
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
foreachIt's worth nothing that array_walk can not be used to change keys in the array.
The function may be defined as (&$value, $key) but not (&$value, &$key).
Even though PHP does not complain/warn, it does not modify the key.Calling an array Walk inside a class
If the class is static:
array_walk($array, array('self', 'walkFunction'));
or
array_walk($array, array('className', 'walkFunction'));
Otherwise:
array_walk($array, array($this, 'walkFunction'));I noticed that :
PHP ignored arguments type when using array_walk() even if there was
declare(strict_types=1) .
See this code as an example ...
<?php
declare(strict_types=1);
$fruits = array("butter" => 5.3, "meat" => 7, "banana" => 3);
function test_print(int $item2, $key) {
echo "$key: $item2<br />\n";
}
array_walk($fruits, 'test_print');
?>
The output is :
butter: 5
meat: 7
banana: 3
whilst the expecting output is :
Fatal error: Uncaught TypeError: Argument 1 passed to test_print() must be of the type integer
because "butter" => 5.3 is float
I asked someone about it and they said "this was caused by the fact that callbacks called from internal code will always use weak type". But I tried to do some tests and this behavior is not an issue when using call_user_func().In response to 'ibolmo', this is an extended version of string_walk, allowing to pass userdata (like array_walk) and to have the function edit the string in the same manner as array_walk allows, note now though that you have to pass a variable, since PHP cannot pass string literals by reference (logically).
<?php
function string_walk(&$string, $funcname, $userdata = null) {
for($i = 0; $i < strlen($string); $i++) {
# NOTE: PHP's dereference sucks, we have to do this.
$hack = $string{$i};
call_user_func($funcname, &$hack, $i, $userdata);
$string{$i} = $hack;
}
}
function yourFunc($value, $position) {
echo $value . ' ';
}
function yourOtherFunc(&$value, $position) {
$value = str_rot13($value);
}
# NOTE: We now need this ugly $x = hack.
string_walk($x = 'interesting', 'yourFunc');
// Ouput: i n t e r e s t i n g
string_walk($x = 'interesting', 'yourOtherFunc');
echo $x;
// Output: vagrerfgvat
?>
Also note that calling str_rot13() directly on $x would be much faster ;-) just a sample.Note that using array_walk with intval is inappropriate.
There are many examples on internet that suggest to use following code to safely escape $_POST arrays of integers:
<?php
array_walk($_POST['something'],'intval'); // does nothing in PHP 5.3.3
?>
It works in _some_ older PHP versions (5.2), but is against specifications. Since intval() does not modify it's arguments, but returns modified result, the code above has no effect on the array and will leave security hole in your website.
You can use following instead:
<?php
$_POST['something'] = array_map(intval,$_POST['something']);
?>There is a note about 3 years ago regarding using this for trimming. array_map() may be cleaner for this. I haven't checked the time/resource impact:
$result = array_map("trim", $array);If you want to unset elements from the callback function, maybe what you really need is array_filter.Don't forget about the array_map() function, it may be easier to use!
Here's how to lower-case all elements in an array:
<?php
$arr = array_map('strtolower', $arr);
?>Since array_walk cannot modify / change / reindex keys as already mentioned, i provide this small wrapping function which accomplishes passing array reference and index using closures , "use" keyword.
function indexArrayByElement($array, $element)
{
$arrayReindexed = [];
array_walk(
$array,
function ($item, $key) use (&$arrayReindexed, $element) {
$arrayReindexed[$item[$element]] = $item;
}
);
return $arrayReindexed;
}// We can make that with this simple FOREACH loop :
$fruits = array("d" => "lemon", "a" => "orange", "b" => "banana", "c" => "apple");
foreach($fruits as $cls => $vls)
{
$fruits[$cls] = "fruit: ".$vls;
}
Results:
Array
(
[d] => fruit: lemon
[a] => fruit: orange
[b] => fruit: banana
[c] => fruit: apple
)I wanted to walk an array and reverse map it into a second array. I decided to use array_walk because it should be faster than a reset,next loop or foreach(x as &$y) loop.
<?php
$output = array();
array_walk($input, 'gmapmark_reverse', $output);
function gmapmark_reverse(&$item, $index, &$target) {
$target[$item['form_key']] = $index;
}
?>
In my debugger I can see that $target is progressively updated, but when array_walk returns, $output is empty. If however I use a (deprecated) call-by-reference:
<?php
array_walk($input, 'gmapmark_reverse', &$output);
?>
$output is returned correctly. Unfortunately there's not an easy way to suppress the warnings:
<?php
@array_walk($input, 'gmapmark_reverse', &$output);
?>
doesn't silence them. I've designed a workaround using a static array:
<?php
$reverse = array();
array_walk($input, 'gmapmark_reverse');
// call function one last time to get target array out, because parameters don't work
$reverse = gmapmark_reverse($reverse);
function gmapmark_reverse(&$item, $index = 0) {
static $target;
if (!$target) {
$target = array();
}
if (isset($item['form_key'])) {
$target[$item['form_key']] = $index;
}
return($target);
}
?>It can be very useful to pass the third (optional) parameter by reference while modifying it permanently in callback function. This will cause passing modified parameter to next iteration of array_walk(). The exaple below enumerates items in the array:
<?php
function enumerate( &$item1, $key, &$startNum ) {
$item1 = $startNum++ ." $item1";
}
$num = 1;
$fruits = array( "lemon", "orange", "banana", "apple");
array_walk($fruits, 'enumerate', $num );
print_r( $fruits );
echo '$num is: '. $num ."\n";
?>
This outputs:
Array
(
[0] => 1 lemon
[1] => 2 orange
[2] => 3 banana
[3] => 4 apple
)
$num is: 1
Notice at the last line of output that outside of array_walk() the $num parameter has initial value of 1. This is because array_walk() does not take the third parameter by reference.. so what if we pass the reference as the optional parameter..
<?php
$num = 1;
$fruits = array( "lemon", "orange", "banana", "apple");
array_walk($fruits, 'enumerate', &$num ); // reference here
print_r( $fruits );
echo '$num is: '. $num ."\n";
echo "we've got ". ($num - 1) ." fruits in the basket!";
?>
This outputs:
Array
(
[0] => 1 lemon
[1] => 2 orange
[2] => 3 banana
[3] => 4 apple
)
$num is: 5
we've got 4 fruits in the basket!
Now $num has changed so we are able to count the items (without calling count() unnecessarily).
As a conclusion, using references with array_walk() can be powerful toy but this should be done carefully since modifying third parameter outside the array_walk() is not always what we want.For those that think they can't use array_walk to change / replace a key name, here you go:
<?php
function array_explore(array &$array, callable $callback)
{
array_walk($array, function(&$value, $key) use (&$array, $callback)
{
$callback($array, $key, $value);
if(is_array($value))
{
array_explore($value, $callback);
}
});
}
/**
* Stolen from: https://stackoverflow.com/questions/13233405/change-key-in-associative-array-in-php
*/
function renameKey(array &$data, $oldKey, $newKey, $ignoreMissing = false, $replaceExisting = false)
{
if (!empty($data))
{
if (!array_key_exists($oldKey, $data))
{
if ($ignoreMissing)
{
return FALSE;
}
throw new \Exception('Old key does not exist.');
}
else
{
if (array_key_exists($newKey, $data))
{
if ($replaceExisting)
{
unset($data[$newKey]);
}
else
{
throw new \Exception('New key already exist.');
}
}
$keys = array_keys($data);
// Fix from EllisGL: http://php.net/manual/en/function.array-search.php#122377
$keys[array_search($oldKey, array_map('strval', $keys))] = $newKey;
$data = array_combine($keys, $data);
return TRUE;
}
}
return FALSE;
}
$array = [
"_10fish" => 'xyz',
"_11fish" => [
"_22" => "a", "b", "c"
],
"someFish" => [
'xyz',
'@attributes' => ['type' => 'cod']
]
];
array_explore($array, function(&$value, $key)
{
// Replace key '@attrutes' with '_attributes'
if('@attributes' === $key)
{
renameKey($value, $key, '_attributes');
}
});
print_r($array);
?>Using lambdas you can create a handy zip function to zip together the keys and values of an array. I extended it to allow you to pass in the "glue" string as the optional userdata parameter. The following example is used to zip an array of email headers:
<?php
/**
* Zip together the keys and values of an array using the provided glue
*
* The values of the array are replaced with the new computed value
*
* @param array $data
* @param string $glue
*/
function zip(&$data, $glue=': ')
{
if(!is_array($data)) {
throw new InvalidArgumentException('First parameter must be an array');
}
array_walk($data, function(&$value, $key, $joinUsing) {
$value = $key . $joinUsing . $value;
}, $glue);
}
$myName = 'Matthew Purdon';
$myEmail = 'matthew@example.com';
$from = "$myName <$myEmail>";
$headers['From'] = $from;
$headers['Reply-To'] = $from;
$headers['Return-path'] = "<$myEmail>";
$headers['X-Mailer'] = "PHP" . phpversion() . "";
$headers['Content-Type'] = 'text/plain; charset="UTF-8"';
zip($headers);
$headers = implode("\n", $headers);
$headers .= "\n";
echo $headers;
/*
From: Matthew Purdon <matthew@example.com>
Reply-To: Matthew Purdon <matthew@example.com>
Return-path: <matthew@example.com>
X-Mailer: PHP5.3.2
Content-Type: text/plain; charset="UTF-8"
*/
?>example with closures, checking and deleting value in array:
<?php
$array = array('foo' => 'bar', 'baz' => 'bat');
array_walk($array, function($val,$key) use(&$array){
if ($val == 'bar') {
unset($array[$key]);
}
});
var_dump($array);