PHP array_column(): pegar uma coluna de várias linhas

array_column($rows, $column) retorna o valor de $column de cada linha numa lista de linhas. Ele transforma uma tabela de registros num array simples de um campo, que é o que você precisa antes de implode, in_array, array_sum ou 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";

As linhas podem vir de qualquer lugar: uma resposta JSON decodificada, um arquivo CSV ou uma consulta ao banco que retornou um array de arrays associativos.

Usar a chave de índice para montar pares chave e valor

O terceiro argumento indica um campo cujo valor vira a chave de cada resultado. array_column($users, 'name', 'id') é o jeito comum de montar uma consulta de id para nome, por exemplo para uma lista <select>.

<?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";

Se duas linhas tiverem o mesmo valor de índice, a linha posterior sobrescreve a anterior.

Indexar linhas inteiras pelo id com null

Passe null como coluna para manter cada linha completa, com a chave trocada pelo campo de índice. Procurar uma linha pelo id vira então um acesso direto pela chave em vez de um loop.

<?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));

Monte o índice uma vez e cada consulta depois disso é instantânea, o que importa quando você procura muitos ids num loop.

Encontrar uma linha com array_column e array_search

Para descobrir qual linha tem determinado valor, busque na coluna e use a posição retornada. Verifique o resultado com !== false, porque uma correspondência na primeira linha retorna 0.

<?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));

Isso depende de $users ter as chaves 0, 1, 2, porque o array_column retorna uma lista. Se o array foi filtrado e tem buracos, chame array_values($users) antes. A página sobre array_search explica em detalhe a armadilha do false e do 0.

Somar, contar ou tirar a média de uma coluna

O array_column combina bem com as funções de matemática: extraia o campo e depois some.

<?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";

Para um valor calculado a partir de vários campos, como quantidade vezes preço, a ferramenta é o array_map, como na última linha.

array_column com objetos

Com uma lista de objetos, o array_column lê propriedades públicas. Propriedades privadas e protegidas não ficam visíveis para ele.

<?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"));

A segunda chamada retorna um array vazio: password é privada, então todos os objetos são pulados.

Linhas sem o campo são puladas

O array_column não coloca um valor substituto para uma linha que não tem o campo. O resultado pode ser menor que a entrada, então as posições deixam de corresponder às linhas.

<?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"));

O primeiro resultado tem dois telefones e nenhuma pista de que Bob não tinha um. Com o nome como chave de índice, você vê de quem é cada número, que é a forma mais segura sempre que algumas linhas podem não ter o campo.