array_walk
配列の全ての要素にユーザー関数を適用する。
説明
boolarray_walk
arrayarray
callbackfunction
mixeduserdata
&return.success;
arrayの各要素にfunction
という名前のユーザ定義関数を適用します。
functionには、配列の値が最初の引数として
渡され、配列のキーが2番目のパラメータとして渡されます。
userdataが指定された場合、3番目の引数として
ユーザー関数に渡されます。
functionが2つまたは3つを超える引数を必要とする場合、
userdataの指定によっては、
array_walkがfunction
をコールする度にE_WARNINGレベルの
エラーが発行されます。これらのエラーは、
array_walkの前に
@エラー演算子を付けるか
error_reportingを使用することにより
抑制されます。
functionにより配列の値そのものを変更する必要
がある場合、functionの最初の引数は
参照として
渡す必要があります。この場合、配列の要素に加えた変更は、配列自体
に対して行われます。
キー及びuserdataをfunctionに渡す処理は、
バージョン4.0.0で追加されました。
array_walkはarrayの
内部配列ポインタに影響されません。array_walkは
ポインタの位置に関わらず配列の全てに渡って適用されます。
ポインタをリセットするにはresetを
使用してください。PHP3ではarray_walkは
ポインタをリセットします。
コールバック関数により配列自身を変更することはできません。
例えば、要素の追加、削除、要素のunset等はできません。
array_walkが適用される配列を
変更しようとすると、関数の動作を定義できず、予期しない結果を
得ることになります。
array_walkの例
"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 "Before ...:\n";
array_walk ($fruits, 'test_print');
array_walk ($fruits, 'test_alter', 'fruit');
echo "... and after:\n";
array_walk ($fruits, 'test_print');
?>
]]>
上のプログラムは次のような出力となります:
list,
foreach,
each,
call_user_func_arrayも参照してください。