array_walk_recursive
(PHP 5)
array_walk_recursive — Apply a user function recursively to every member of an array
Description
Applies the user-defined function funcname to each element of the input array. This function will recur into deeper arrays.
Parameters
- input
-
The input array.
- funcname
-
Typically, funcname takes on two parameters. The input parameter's value being the first, and the key/index second.
Note:
If funcname needs to be working with the actual values of the array, specify the first parameter of funcname as a reference. Then, any changes made to those elements will be made in the original array itself.
- userdata
-
If the optional userdata parameter is supplied, it will be passed as the third parameter to the callback funcname.
Return Values
Returns TRUE on success or FALSE on failure.
Examples
Example #1 array_walk_recursive() example
<?php
$sweet = array('a' => 'apple', 'b' => 'banana');
$fruits = array('sweet' => $sweet, 'sour' => 'lemon');
function test_print($item, $key)
{
echo "$key holds $item\n";
}
array_walk_recursive($fruits, 'test_print');
?>
The above example will output:
a holds apple b holds banana sour holds lemon
You may notice that the key 'sweet' is never displayed. Any key that holds an array will not be passed to the function.
See Also
- array_walk() - Apply a user function to every member of an array
- information about the callback type