PHPのarray_walk_recursive()関数の使い方を徹底解説

array_walk_recursive()関数は、ユーザー定義関数を配列のすべての要素に対して再帰的に適用するための組み込み関数です。多次元配列の各要素（リーフノード）に関数を処理させたい場合に非常に便利です。

構文

array_walk_recursive(arr, custom_func, parameter)

パラメータ

• arr − 処理の対象となる配列を指定します。必須です。

• custom_func − 各要素に適用するユーザー定義関数を指定します。必須です。コールバック関数には通常、「値」と「キー」がこの順で引数として渡されます。

• parameter − カスタム関数に追加で渡すパラメータを指定します。省略可能です。指定した場合は、コールバック関数の第3引数として渡されます。

戻り値

array_walk_recursive()関数は、成功した場合に TRUE、失敗した場合に FALSE を返します。

使用例1：基本的な使い方

以下は、多次元配列のすべての要素に対してキーと値を出力する例です。

<?php
function display($val,$key) {
   echo "Key $key with the value $val<br>";
}
$arr1 = array("p"=>"accessories","q"=>"footwear");
$arr2 = array($arr1,"1"=>"electronics");
array_walk_recursive($arr2,"display");
?>

出力結果

Key p with the value accessories
Key q with the value footwear
Key 1 with the value electronics

この例では、$arr2 の中に含まれる配列 $arr1 の要素も含めて、すべての末端要素が再帰的に処理されていることがわかります。

使用例2：追加パラメータを渡す方法

次に、第3引数を使ってカスタム関数に追加のパラメータを渡す例を見てみましょう。

<?php
function display($val,$key, $extra) {
   echo "Key $key $extra $val<br>";
}
$arr1 = array("p"=>"accessories","q"=>"footwear");
$arr2 = array($arr1,"5"=>"electronics");
array_walk_recursive($arr2,"display", "with value");
?>

出力結果

Key p with the value accessories
Key q with the value footwear
Key 5 with the value electronics

このように、第3引数「with value」がコールバック関数の $extra に渡され、出力メッセージの中で利用されています。

まとめ

• array_walk_recursive() は多次元配列の全要素にユーザー定義関数を再帰的に適用できる。

• コールバック関数には値・キーの順で引数が渡され、必要に応じて追加パラメータも指定できる。

• 戻り値は成否を表す TRUE / FALSE のみで、配列自体を変更する場合はコールバック内で参照渡し（&$val）を使う。