Description

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

Exécute la fonction callback définie par l'utilisateur sur chaque élément du tableau array.

array_walk() n'est pas affecté par le pointeur interne du tableau array. array_walk() traversera le tableau en totalité sans se soucier de la position du pointeur.

Liste de paramètres

array

Le tableau d'entrée.

callback

Typiquement, callback prend deux paramètres. La valeur du paramètre array étant le premier et la clé/index, le second.

Note:
Si callback doit travailler avec les véritables valeurs du tableau, spécifiez que le premier paramètre de callback doit être passé par référence. Alors, les éléments seront directement modifiés dans le tableau.

Note:
Plusieurs fonctions internes (par exemple, strtolower()) lèvent une exception si plus d'arguments que ceux attendus sont passés à la fonction et ne sont pas utilisables directement comme callback.

Seules les valeurs du array peuvent être modifiées ; sa structure ne peut pas, c'est-à-dire que l'on ne peut ajouter, supprimer ou réordonner des éléments. Si la fonction de callback ne respecte pas cette règle, le comportement va devenir indéfini et imprévisible.

arg

Si le paramètre optionnel arg est fourni, il sera passé comme troisième paramètre à la fonction définie par l'utilisateur callback.

Valeurs de retour

Retourne toujours true.

Erreurs / Exceptions

À partir de PHP 7.1.0, un ArgumentCountError sera levé si la fonction callback requiert plus de 2 paramètres (la valeur et la clé de l'élément du tableau), ou plus de 3 si arg est aussi fourni. Précédemment, dans ce cas une erreur de niveau E_WARNING aurait été générée à chaque fois que la fonction array_walk() appelle callback.

Historique

Version	Description
8.2.0	Le type de retour est maintenant `true`, auparavant il était bool.
8.0.0	Si `callback` attend que le deuxième ou troisième paramètre soit passé par référence, cette fonction émet désormais une `E_WARNING`.

Exemples

Exemple #1 Exemple avec array_walk()

<?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\n";
}

echo "Avant ...:\n";
array_walk($fruits, 'test_print');

array_walk($fruits, 'test_alter', 'fruit');
echo "... et après :\n";

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

L'exemple ci-dessus va afficher :

Avant ...:
d. lemon
a. orange
b. banana
c. apple
... et après :
d. fruit: lemon
a. fruit: orange
b. fruit: banana
c. fruit: apple

Exemple #2 Exemple de array_walk() avec l'utilisation d'une fonction anonyme

<?php
$elements = ['a', 'b', 'c'];

array_walk($elements, function ($value, $key) {
  echo "{$key} => {$value}\n";
});

?>

L'exemple ci-dessus va afficher :

0 => a
1 => b
2 => c

Voir aussi

array_walk_recursive() - Applique une fonction de rappel récursivement à chaque membre d'un tableau
iterator_apply() - Appelle une fonction pour tous les éléments d'un itérateur
list() - Assigne des variables comme si elles étaient un tableau
each() - Retourne chaque paire clé/valeur d'un tableau
call_user_func_array() - Appelle une fonction de rappel avec les paramètres rassemblés en tableau
array_map() - Applique une fonction sur les éléments d'un tableau
foreach