PHPのarray_filter()：値やキーで配列を絞り込む

array_filter($array, $callback)は、$callbackがtrue（またはtrueに変換される値）を返した$arrayの要素を返します。配列が先、コールバックが後で、残った要素は元のキーを保ちます。

<?php
$numbers = [1, 2, 3, 4, 5, 6, 7, 8];

$even = array_filter($numbers, fn($n) => $n % 2 === 0);

print_r($even);

結果のキーは1, 3, 5, 7で、元の配列でそれらの値があった位置です。この点は見た目以上に重要で、2つ後の節でその扱い方を説明します。

配列から空の値を取り除く

コールバックなしでarray_filterを呼ぶと、falseに変換される値をすべて取り除きます。空文字列、null、false、0、"0"、空の配列です。explode()の結果やフォームの項目のリストをきれいにするいちばん手早い方法です。

<?php
$fields = ["Ada", "", null, "0", 0, "London", false, []];

print_r(array_filter($fields));

// Keep 0 and "0", drop only "" and null
print_r(array_filter($fields, fn($v) => $v !== '' && $v !== null));

最初の結果では"0"と0も消えていますが、これらは本当のデータであることがよくあります（数量の0、郵便番号の数字）。0が正当な答えなら、2つ目の呼び出しのようにコールバックを自分で書きましょう。PHPが空とみなす値の完全な一覧はemptyのページにあります。

array_valuesで結果の番号を振り直す

キーが保たれるので、絞り込んだリストには欠番ができることがあります。すると0からのforループは存在しないキーにぶつかり、json_encodeは結果をJSON配列ではなくJSONオブジェクトにします。array_values()で番号を振り直します。

<?php
$words = ["apple", "kiwi", "banana", "fig"];

$long = array_filter($words, fn($w) => strlen($w) > 4);

echo json_encode($long), "\n";
echo json_encode(array_values($long)), "\n";

ARRAY_FILTER_USE_KEYでキーによって絞り込む

3つ目の引数で、コールバックが受け取るものを選びます。ARRAY_FILTER_USE_KEYはキーだけを渡し、ARRAY_FILTER_USE_BOTHは値とキーをこの順で渡します。

<?php
$config = [
    "db_host" => "localhost",
    "db_port" => 5432,
    "app_name" => "Shop",
    "app_debug" => false,
];

// Keep only keys that start with db_
print_r(array_filter($config, fn($key) => str_starts_with($key, 'db_'), ARRAY_FILTER_USE_KEY));

$scores = ["ada" => 92, "bob" => 48, "cy" => 75, "dee" => 55];

// Value and key: a passing score and a name longer than two letters
print_r(array_filter(
    $scores,
    fn($score, $name) => $score >= 50 && strlen($name) > 2,
    ARRAY_FILTER_USE_BOTH
));

すでにわかっている決まったキーの集合を残すなら、array_intersect_key($config, array_flip(['db_host', 'db_port']))がコールバックなしで同じことをします。

多次元配列を絞り込む

実際のデータのほとんどは行のリストです。コールバックは1回に1行を受け取るので、必要なフィールドを判定します。

<?php
$products = [
    ["name" => "Keyboard", "price" => 49, "inStock" => true],
    ["name" => "Monitor", "price" => 189, "inStock" => false],
    ["name" => "Mouse", "price" => 19, "inStock" => true],
    ["name" => "Webcam", "price" => 65, "inStock" => true],
];

$maxPrice = 60;

$affordable = array_filter(
    $products,
    fn($p) => $p["inStock"] && $p["price"] <= $maxPrice
);

foreach ($affordable as $p) {
    echo "{$p['name']}: \${$p['price']}\n";
}

$maxPriceを変えて、もう一度実行してみてください。そのあと名前だけを取り出すには、結果をarray_columnに渡します：array_column($affordable, 'name')。

絞り込んで、変換して、集計する

array_filterは要素を選び、array_mapは要素を変え、array_reduceは配列を1つの値にまとめます。array_reduce($array, $callback, $initial)は、途中までの合計と次の要素でコールバックを呼び出します。

<?php
$orders = [
    ["id" => 1, "total" => 120.0, "status" => "paid"],
    ["id" => 2, "total" => 35.5, "status" => "refunded"],
    ["id" => 3, "total" => 80.0, "status" => "paid"],
    ["id" => 4, "total" => 15.0, "status" => "paid"],
];

$paid = array_filter($orders, fn($o) => $o["status"] === "paid");

$totals = array_map(fn($o) => $o["total"], $paid);

$revenue = array_reduce($totals, fn($sum, $t) => $sum + $t, 0);

echo "Paid orders: " . count($paid) . "\n";
echo "Revenue: $revenue\n";

単純な合計ならarray_sum($totals)のほうが短く書けます。array_reduceが役に立つのは、結果がそれ以外のもの、たとえば文字列、グループごとの件数、いちばん大きな行のときです。

よくあるミス：array_filterの中で値を変更する

コールバックの戻り値は、要素を残すかどうかを決めるだけです。それ以外に計算したものは捨てられるので、次のコードは何もtrimしません。

<?php
$names = ["  Ada ", "", " Grace"];

// Looks like it trims, but array_filter keeps the original values
$wrong = array_filter($names, fn($n) => trim($n));
var_dump($wrong);

// Trim first, then filter
$right = array_values(array_filter(array_map('trim', $names)));
var_dump($right);

array_mapで変換してから絞り込み、きれいなリストが必要ならarray_valuesを加えましょう。