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

PHPのarray_filter()関数は、ユーザーが定義したコールバック関数を使って配列の要素を絞り込む（フィルタリングする）ための関数です。コールバック関数がtrueを返した要素だけが残り、フィルタリング済みの新しい配列として返されます。

基本構文

array_filter(arr, callback, flag)

パラメータ

• arr ー フィルタリングの対象となる配列を指定します。

• callback ー 各要素の判定に使用するコールバック関数を指定します。この関数がtrueを返す要素のみが結果の配列に残ります。

• flag ー コールバック関数に渡す引数の種類を指定するオプションです。以下の定数が利用できます。

  • ARRAY_FILTER_USE_KEY ー 値ではなく、キーのみをコールバック関数に渡します。

  • ARRAY_FILTER_USE_BOTH ー 値とキーの両方をコールバック関数に渡します。

戻り値

array_filter()関数は、コールバック関数による判定を通過した要素のみを含む、フィルタリング済みの配列を返します。なお、元の配列のキーは保持される点に注意してください。そのため、結果の配列ではインデックスが連続しない場合があります。

使用例

次の例では、偶数だけを抽出するコールバック関数「check」を定義し、配列から偶数の要素を取り出しています。

<?php
function check($arr) {
   return(!($arr & 1));
}
$arr1 = array(3, 6, 9, 15, 20, 30, 45, 48, 59, 66);
print_r(array_filter($arr1, "check"));
?>

実行結果

Array
(
[1] => 6
[4] => 20
[5] => 30
[7] => 48
[9] => 66
)

ポイントまとめ

• コールバック関数がtrueを返した要素のみが残ります。

• 元の配列のキーは維持されるため、必要に応じてarray_values()でインデックスを振り直すと便利です。

• callbackにnullを指定すると、falseと評価される要素（0、空文字列、nullなど）をすべて除去できます。