array_walk
(PHP 4, PHP 5, PHP 7)
array_walk — Apply a user supplied function to every member of an array
Description
Applies the user-defined callback function to each
element of the array array.
array_walk() is not affected by the internal array
pointer of array. array_walk()
will walk through the entire array regardless of pointer position.
Parameters
-
array -
The input array.
-
callback -
Typically,
callbacktakes on two parameters. Thearrayparameter's value being the first, and the key/index second.Note:
If
callbackneeds to be working with the actual values of the array, specify the first parameter ofcallbackas a reference. Then, any changes made to those elements will be made in the original array itself.Note:
Many internal functions (for example strtolower()) will throw a warning if more than the expected number of argument are passed in and are not usable directly as a
callback.Only the values of the
arraymay potentially be changed; its structure cannot be altered, i.e., the programmer cannot add, unset or reorder elements. If the callback does not respect this requirement, the behavior of this function is undefined, and unpredictable. -
userdata -
If the optional
userdataparameter is supplied, it will be passed as the third parameter to thecallback.
Errors/Exceptions
As of PHP 7.1.0, an ArgumentCountError will be thrown if the callback function
requires more than 2 parameters (the value and key of the array member).
Previously, if the callback function required more than 2 parameters,
an error of level E_WARNING would be generated each time
array_walk() calls callback.
Examples
Example #1 array_walk() example
<?php
$fruits = array("d" => "lemon", "a" => "orange", "b" => "banana", "c" => "apple");
function test_alter(&$item1, $key, $prefix)
{
$item1 = "$prefix: $item1";
}
function test_print($item2, $key)
{
echo "$key. $item2<br />\n";
}
echo "Before ...:\n";
array_walk($fruits, 'test_print');
array_walk($fruits, 'test_alter', 'fruit');
echo "... and after:\n";
array_walk($fruits, 'test_print');
?>
The above example will output:
Before ...: d. lemon a. orange b. banana c. apple ... and after: d. fruit: lemon a. fruit: orange b. fruit: banana c. fruit: apple
See Also
- array_walk_recursive() - Apply a user function recursively to every member of an array
- iterator_apply() - Call a function for every element in an iterator
- list() - Assign variables as if they were an array
- each() - Return the current key and value pair from an array and advance the array cursor
- call_user_func_array() - Call a callback with an array of parameters
- array_map() - Applies the callback to the elements of the given arrays
- information about the callback type
- foreach
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-array-walk.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
