PHP array_search(): encontrar la clave de un valor

array_search($value, $array) devuelve la clave del primer elemento igual a $value, o false si ningún elemento coincide. Como una clave encontrada puede ser 0, comprueba el resultado con !== false, como en 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

Si solo necesitas un sí o un no, in_array() lo dice directamente. array_search() es para cuando necesitas saber dónde está el valor, por ejemplo para cambiarlo o eliminarlo.

La trampa de 0 vs false

El bug más común de array_search(): el valor es el primer elemento, su clave es 0 y if ($key) trata 0 como falso. El código dice "no encontrado" para un valor que está justo ahí. Compara con !== false, que solo coincide con un false real.

<?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 tiene el mismo bug que if ($key), porque 0 == false es true. Solo el operador estricto los distingue.

Búsqueda estricta

Igual que in_array(), array_search() compara con == salvo que pases true como tercer argumento. El modo flexible permite que una cadena encuentre un número y que null encuentre 0, lo que devuelve una clave que no esperabas.

<?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 las claves con un valor

array_search() se detiene en la primera coincidencia. array_keys($array, $value) devuelve todas las claves que coinciden como un array; añade true para una comparación estricta. Un resultado vacío significa que no hay coincidencias, así que no hay confusión entre 0 y 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 en un array multidimensional con array_column

array_search() no busca dentro de arrays anidados. En una lista de filas, extrae con array_column() el campo que buscas; las posiciones de esa lista coinciden con los números de fila, así que el resultado es el índice de la fila.

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

array_column() renumera su salida desde 0, así que esto solo encaja cuando las filas están numeradas 0, 1, 2 sin huecos. Después de unset() o array_filter() la numeración tiene huecos; aplica antes array_values() a las filas o usa la búsqueda por clave de las dos últimas líneas. array_column() explica más sobre la forma con clave de índice.

Búsqueda sin distinguir mayúsculas y minúsculas

array_search() compara las cadenas exactamente. Pasa los dos lados a minúsculas para ignorar las mayúsculas. array_map() conserva las claves, así que la clave que obtienes es la del 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 y reemplazar o eliminar

El motivo habitual para buscar es actuar sobre el elemento encontrado. Con la clave en la mano, asigna para cambiarlo o usa unset() para eliminarlo, y protégete siempre antes con !== false: unset($arr[false]) elimina en silencio el elemento con clave 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);