Home > PHP > Function > Arrays > array_walk()

array_walk()

array_walk - Apply a user function to every member of an array

Syntax

bool array_walk (array &$array, callback $funcname, mixed $userdata)

Arguments

  • array - The input array.
  • funcname - Typically, funcname takes on two parameters. The array 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. Users may not change the array itself from the callback function. e.g. Add/delete elements, unset elements, etc. If the array that array_walk() is applied to is changed, 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 funcname.

Description

Applies the user-defined function funcname to each element of the array array.

Version

PHP 4, 5

Return value

Returns TRUE on success or FALSE on failure.