PHP Manual»Funciones de Arrays»array_walk_recursive

array_walk_recursive

(PHP 5, PHP 7, PHP 8)

array_walk_recursive — Aplica una función de retrollamada de manera recursiva a cada miembro de un array

Descripción

function array_walk_recursive(array|object &$array, callable $callback, mixed $arg = null): true

Aplica la función de usuario callback a cada elemento del array array. Esta función se reproducirá en todas las profundidades del array.

Se permite pasar un objeto como array, y se tratará como si hubiera sido convertido previamente en un array. Independientemente de si la función comenzó con un array o un objeto, no recursará en los objetos internos.

Parámetros

array: El array de entrada.
callback: Típicamente, callback toma 2 argumentos. El argumento array, representando el valor, es el primero, el índice/clave, el segundo.

Nota:
Si callback debe ser ejecutado con los valores actuales del array, especifique el primer argumento de callback por referencia. Entonces, cualquier cambio efectuado en los elementos de este array será también efectuado en el array original.
arg: Si el argumento opcional arg es proporcionado, será pasado como tercer argumento a la función de retrollamada callback.

Valores devueltos

Retorna siempre true.

Historial de cambios

Versión	Descripción
8.2.0	El tipo de retorno es ahora `true`, anteriormente era bool.

Ejemplos

Ejemplo #1 Ejemplo con array_walk_recursive()

<?php
$sweet = array('a' => 'apple', 'b' => 'banana');
$fruits = array('sweet' => $sweet, 'sour' => 'lemon');

function test_print($item, $key)
{
    echo "La clave $key contiene el elemento $item\n";
}

array_walk_recursive($fruits, 'test_print');
?>

El ejemplo anterior mostrará:

La clave a contiene el elemento apple
La clave b contiene el elemento banana
La clave sour contiene el elemento lemon

Se habrá notado que la clave 'sweet' nunca es mostrada. Cualquier clave que esté asociada a un array no es pasada a la función de retrollamada.

array_walk_recursive() también puede utilizarse para actualizar los valores in situ pasando el parámetro de la retrollamada por referencia.

Ejemplo #2 Actualización de los valores in situ

<?php
$sweet = ['a' => 'apple', 'b' => 'banana'];
$fruits = ['sweet' => $sweet, 'sour' => 'lemon'];

function test_update(&$item)
{
    $item = strtoupper($item);
}

function test_print($item, $key)
{
    echo "La clave $key contiene el elemento $item\n";
}

array_walk_recursive($fruits, 'test_update');
array_walk_recursive($fruits, 'test_print');
?>

El ejemplo anterior mostrará:

La clave a contiene el elemento APPLE
La clave b contiene el elemento BANANA
La clave sour contiene el elemento LEMON

Véase también

array_walk() - Ejecuta una función proporcionada por el usuario en cada uno de los elementos de un array