PHP array_search(): encontrar a chave de um valor

array_search($value, $array) retorna a chave do primeiro elemento igual a $value, ou false se nenhum elemento bate. Como uma chave encontrada pode ser 0, teste o resultado com !== false, como em if (($key = array_search('pear', $fruits)) !== false).

<?php
$fruits = ['apple', 'pear', 'plum'];

$key = array_search('pear', $fruits);
var_dump($key);

$key = array_search('kiwi', $fruits);
var_dump($key);

$prices = ['apple' => 1.20, 'pear' => 0.90];
echo array_search(0.90, $prices), "\n";   // works with string keys too

Se você só precisa de um sim ou não, o in_array() diz isso diretamente. O array_search() serve para quando você precisa saber onde o valor está, por exemplo para alterá-lo ou removê-lo.

A armadilha do 0 e do false

O bug mais comum do array_search(): o valor é o primeiro elemento, a chave dele é 0, e if ($key) trata 0 como falso. O código diz "não encontrado" para um valor que está bem ali. Compare com !== false, que só bate com um false de verdade.

<?php
$queue = ['Ada', 'Linus', 'Grace'];

if (array_search('Ada', $queue)) {
    echo "Wrong check: found\n";
} else {
    echo "Wrong check: not found\n";      // this runs, key is 0
}

$key = array_search('Ada', $queue);
if ($key !== false) {
    echo "Right check: found at $key\n";
}

!= false tem o mesmo bug que if ($key), porque 0 == false é true. Só o operador estrito distingue os dois.

Busca estrita

Como o in_array(), o array_search() compara com ==, a menos que você passe true como terceiro argumento. O modo frouxo deixa uma string encontrar um número e null encontrar 0, o que retorna uma chave inesperada.

<?php
$ids = [10, 20, 30];
var_dump(array_search('20', $ids));         // loose: "20" == 20
var_dump(array_search('20', $ids, true));   // strict: no match

$stock = ['apples' => 5, 'pears' => 0];
var_dump(array_search(null, $stock));       // null == 0: finds 'pears'
var_dump(array_search(null, $stock, true));

Encontrar todas as chaves com um valor

O array_search() para na primeira correspondência. array_keys($array, $value) retorna todas as chaves que batem como um array; adicione true para uma comparação estrita. Um resultado vazio significa nenhuma correspondência, então não há confusão entre 0 e false.

<?php
$seats = ['A1' => 'free', 'A2' => 'taken', 'A3' => 'free', 'A4' => 'taken'];

echo array_search('free', $seats), "\n";          // first only
print_r(array_keys($seats, 'free', true));       // all of them

$colors = ['red', 'blue', 'red', 'green', 'red'];
echo implode(', ', array_keys($colors, 'red')), "\n";

Buscar num array multidimensional com array_column

O array_search() não olha dentro de arrays aninhados. Para uma lista de linhas, extraia o campo que você está buscando com array_column(); as posições nessa lista correspondem aos números das linhas, então o resultado é o índice da linha.

<?php
$users = [
    ['id' => 101, 'name' => 'Ada',   'email' => 'ada@example.com'],
    ['id' => 102, 'name' => 'Linus', 'email' => 'linus@example.com'],
    ['id' => 103, 'name' => 'Grace', 'email' => 'grace@example.com'],
];

$i = array_search('linus@example.com', array_column($users, 'email'), true);
if ($i !== false) {
    echo "Found {$users[$i]['name']} with id {$users[$i]['id']}\n";
}

// When rows are looked up often, index them once by the field instead
$byEmail = array_column($users, null, 'email');
echo $byEmail['grace@example.com']['id'], "\n";

O array_column() renumera a saída a partir de 0, então isso só se alinha quando as linhas são numeradas 0, 1, 2 sem buracos. Depois de unset() ou array_filter() a numeração tem buracos; rode array_values() nas linhas antes ou use a consulta por chave das duas últimas linhas. O array_column() tem mais sobre a forma com chave de índice.

Busca sem diferenciar maiúsculas

O array_search() compara strings com exatidão. Deixe os dois lados em minúsculas para ignorar a diferença. O array_map() mantém as chaves, então a chave que você recebe de volta é a chave do array original.

<?php
$tags = ['first' => 'PHP', 'second' => 'Laravel', 'third' => 'MySQL'];

var_dump(array_search('mysql', $tags, true));

$lower = array_map('strtolower', $tags);
$key = array_search(strtolower('mysql'), $lower, true);
var_dump($key);
echo $tags[$key], "\n";

Buscar e substituir ou remover

O motivo comum para buscar é agir sobre o elemento encontrado. Com a chave em mãos, atribua para alterá-lo ou use unset() para removê-lo, e sempre proteja antes com !== false: unset($arr[false]) remove em silêncio o elemento com a chave 0.

<?php
$todo = ['buy milk', 'call Ada', 'write report'];

$key = array_search('call Ada', $todo, true);
if ($key !== false) {
    $todo[$key] = 'call Ada (done)';
}

$key = array_search('buy milk', $todo, true);
if ($key !== false) {
    unset($todo[$key]);
}

$todo = array_values($todo);   // renumber after unset
print_r($todo);