PHPのarray_walk()関数とは？使い方とサンプルコードを解説

array_walk()関数とは

array_walk()関数は、配列のすべての要素に対して、ユーザーが定義した関数（コールバック関数）を適用するためのPHPの組み込み関数です。処理が成功した場合はTRUEを、失敗した場合はFALSEを返します。

構文

array_walk(arr, custom_func, parameter)

パラメータ

• arr − 適用対象となる配列。必須です。

• custom_func − 配列の各要素に適用するユーザー定義関数。必須です。

• parameter − カスタム関数に渡す追加パラメータ。省略可能です。

戻り値

array_walk()関数は、処理が成功した場合にTRUEを、失敗した場合にFALSEを返します。なお、この関数は配列そのものに直接処理を行うため、処理後の配列を戻り値として返すわけではない点に注意してください。

コールバック関数の引数について

コールバック関数には、最初の引数として配列の「値」、2番目の引数として「キー」が自動的に渡されます。3番目のパラメータを指定した場合は、それが3番目の引数として渡されます。

使用例

以下は、array_walk()関数を使用して、連想配列の各要素をキーとともに表示するサンプルコードです。

<?php
function display($val, $key) {
   echo "$key id : Student $val<br>";
}
$arr = array("p"=>"Tom", "q"=>"Jack", "r"=>"Amit");
array_walk($arr, "display");
?>

出力結果

上記のコードを実行すると、次のように出力されます。

p id : Student Tom
q id : Student Jack
r id : Student Amit

まとめ

array_walk()関数を使うことで、配列の各要素に対して共通の処理を簡潔に実行できます。foreach文でループを書く代わりに、コールバック関数を指定するだけで済むため、コードの可読性と再利用性が向上します。配列全体に一括処理を行いたい場合にぜひ活用してください。