PHPのarray_column()：多次元配列から列を取得する

array_column($rows, $column)は、行のリストのすべての行から$columnの値を返します。レコードの表を1つのフィールドの平らな配列に変えるもので、implode、in_array、array_sum、array_searchの前に必要になる処理です。

<?php
$users = [
    ["id" => 3, "name" => "Ada", "email" => "ada@example.com"],
    ["id" => 7, "name" => "Bob", "email" => "bob@example.com"],
    ["id" => 9, "name" => "Cy", "email" => "cy@example.com"],
];

$emails = array_column($users, "email");
print_r($emails);

echo implode(", ", array_column($users, "name")), "\n";

行の出どころは何でもかまいません。デコードしたJSONのレスポンス、CSVファイル、連想配列の配列を返したデータベースのクエリなどです。

インデックスキーでキーと値のペアを作る

3つ目の引数には、その値が各結果のキーになるフィールドを指定します。array_column($users, 'name', 'id')は、たとえば<select>のリスト用に、IDから名前を引く表を作る定番の方法です。

<?php
$users = [
    ["id" => 3, "name" => "Ada", "role" => "admin"],
    ["id" => 7, "name" => "Bob", "role" => "editor"],
    ["id" => 9, "name" => "Cy", "role" => "viewer"],
];

$names = array_column($users, "name", "id");
print_r($names);

echo $names[7], "\n";

2つの行が同じインデックスの値を持つ場合は、あとの行が前の行を上書きします。

nullで行全体をIDで索引付けする

列にnullを渡すと、各行全体をインデックスのフィールドでキーを付け直して保ちます。IDで行を探すのが、ループではなく直接のキーアクセスになります。

<?php
$products = [
    ["sku" => "A12", "name" => "Lamp", "price" => 29],
    ["sku" => "B07", "name" => "Desk", "price" => 199],
    ["sku" => "C33", "name" => "Chair", "price" => 89],
];

$bySku = array_column($products, null, "sku");

$sku = "B07";
if (isset($bySku[$sku])) {
    echo "{$bySku[$sku]['name']} costs {$bySku[$sku]['price']}\n";
}

print_r(array_keys($bySku));

索引を一度作れば、それ以降の検索は一瞬で終わります。ループの中で多くのIDを探すときに効いてきます。

array_columnとarray_searchで行を見つける

ある値を持つ行がどれかを見つけるには、列を検索して返ってきた位置を使います。最初の行で一致すると0が返るので、結果は!== falseで確認します。

<?php
$users = [
    ["name" => "Ada", "email" => "ada@example.com"],
    ["name" => "Bob", "email" => "bob@example.com"],
    ["name" => "Cy", "email" => "cy@example.com"],
];

$wanted = "bob@example.com";
$index = array_search($wanted, array_column($users, "email"));

if ($index !== false) {
    echo "Found: {$users[$index]['name']} at position $index\n";
} else {
    echo "No user with $wanted\n";
}

// Just checking existence
var_dump(in_array("zoe@example.com", array_column($users, "email"), true));

これは$usersのキーが0, 1, 2であることを前提にしています。array_columnはリストを返すからです。配列が絞り込まれて欠番があるなら、先にarray_values($users)を呼びます。falseと0の落とし穴についてはarray_searchのページで詳しく扱っています。

列を合計する、数える、平均する

array_columnは数学のヘルパー関数と相性がよく、フィールドを取り出してから合計できます。

<?php
$cart = [
    ["item" => "Book", "qty" => 2, "price" => 12.5],
    ["item" => "Pen", "qty" => 10, "price" => 1.2],
    ["item" => "Bag", "qty" => 1, "price" => 30.0],
];

$qtys = array_column($cart, "qty");
echo "Items: " . array_sum($qtys) . "\n";

$prices = array_column($cart, "price");
echo "Most expensive: " . max($prices) . "\n";
echo "Average price: " . round(array_sum($prices) / count($prices), 2) . "\n";

$total = array_sum(array_map(fn($row) => $row["qty"] * $row["price"], $cart));
echo "Total: $total\n";

数量かける価格のように複数のフィールドから計算する値には、最後の行のようにarray_mapを使います。

オブジェクトに対するarray_column

オブジェクトのリストでは、array_columnはpublicなプロパティを読みます。privateとprotectedのプロパティは見えません。

<?php
class User
{
    public function __construct(
        public int $id,
        public string $name,
        private string $password,
    ) {}
}

$users = [
    new User(1, "Ada", "x"),
    new User(2, "Bob", "y"),
];

print_r(array_column($users, "name", "id"));
var_dump(array_column($users, "password"));

2つ目の呼び出しは空の配列を返します。passwordはprivateなので、すべてのオブジェクトが飛ばされます。

フィールドのない行は飛ばされる

array_columnは、フィールドを持たない行のために代わりの値を埋めたりしません。結果は入力より短くなることがあり、その場合、位置は行と対応しなくなります。

<?php
$people = [
    ["name" => "Ada", "phone" => "555-0101"],
    ["name" => "Bob"],
    ["name" => "Cy", "phone" => "555-0199"],
];

print_r(array_column($people, "phone"));

// Keep the link to each person with an index key
print_r(array_column($people, "phone", "name"));

最初の結果には電話番号が2つあり、Bobが持っていなかったことはわかりません。名前をインデックスキーにすれば、どの番号が誰のものかがわかります。フィールドを持たない行があるかもしれないときは、こちらのほうが安全な形です。