Menu Samaritan's Purse

ARRAY_WALK

Apply a user supplied function to every member of an array

SYNTAX

array_walk ( array &$array , callable $callback [, mixed $userdata = NULL ] ) : bool

PARAMETERS

array

The input array.

callback

Typically, callback takes on two parameters. The array parameter's value being the first, and the key/index second.

Note: If callback needs to be working with the actual values of the array, specify the first parameter of callback as 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 array may 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 userdata parameter is supplied, it will be passed as the third parameter to the callback.

RETURN

Returns TRUE.

EXAMPLES

ARRAY CALLBACK

Array
(
    [a] => oranges
    [b] => bananas
    [c] => apples
    [d] => lemons
)

USERDATA

Array
(
    [a] => fruit: oranges
    [b] => fruit: bananas
    [c] => fruit: apples
    [d] => fruit: lemons
)

INTERNAL

array_combine

array_merge

array_values

EXTERNAL

PHP