PHP array_search(): найти ключ по значению

array_search($value, $array) возвращает ключ первого элемента, равного $value, или false, если подходящего элемента нет. Поскольку найденный ключ может быть 0, проверяйте результат через !== false, как в 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

Если нужен только ответ "да" или "нет", in_array() даёт его напрямую. array_search() нужна, когда важно знать, где находится значение, например чтобы изменить или удалить его.

Ловушка 0 и false

Самая частая ошибка с array_search(): значение стоит первым, его ключ 0, а if ($key) считает 0 ложью. Код говорит "не найдено" про значение, которое лежит прямо там. Сравнивайте через !== false, оно совпадает только с настоящим false.

<?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 та же ошибка, что и у if ($key), потому что 0 == false даёт true. Различить их может только строгий оператор.

Строгий поиск

Как и in_array(), array_search() сравнивает через ==, если не передать true третьим аргументом. Нестрогий режим позволяет строке найти число, а null найти 0, и функция возвращает неожиданный ключ.

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

Все ключи с заданным значением

array_search() останавливается на первом совпадении. array_keys($array, $value) возвращает все подходящие ключи массивом; добавьте true для строгого сравнения. Пустой результат означает, что совпадений нет, так что путаницы 0 и 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";

Поиск в многомерном массиве через array_column

array_search() не заглядывает во вложенные массивы. Для списка строк извлеките нужное поле через array_column(); позиции в этом списке совпадают с номерами строк, поэтому результат и есть индекс строки.

<?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() нумерует свой результат заново с 0, поэтому всё сходится, только когда строки пронумерованы 0, 1, 2 без пропусков. После unset() или array_filter() в нумерации появляются пропуски; сначала примените к строкам array_values() или используйте поиск по ключу из двух последних строк. Подробнее о форме с ключом индекса на странице array_column().

Поиск без учёта регистра

array_search() сравнивает строки точно. Чтобы не учитывать регистр, приведите обе стороны к нижнему. array_map() сохраняет ключи, поэтому полученный ключ это ключ в исходном массиве.

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

Найти и заменить или удалить

Обычно ищут, чтобы что-то сделать с найденным элементом. Получив ключ, присвойте по нему, чтобы изменить элемент, или вызовите unset(), чтобы удалить его, но всегда сначала проверяйте !== false: unset($arr[false]) молча удаляет элемент с ключом 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);