array_search

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

array_search — Ищет значение в массиве, и если находит, возвращает ключ первого найденного элемента

Описание

array_search(mixed $needle, array $haystack, bool $strict = false): int|string|false

Функция ищет «иголку» needle в «стоге сена» haystack.

Список параметров

needle: Искомое значение.

Замечание:
Функция сравнивает строковое значение needle с учётом регистра.
haystack: Массив.
strict: Функция array_search() будет искать идентичные элементы в массиве haystack, если третьему параметру strict установили значение true. Поэтому функция также выполнит строгое сравнение типа значения needle в массиве haystack, а индекс объекта функция найдёт, если объект окажется тем же экземпляром.

Возвращаемые значения

Функция возвращает ключ значения needle, если нашла значение в массиве, иначе возвращает значение false.

Функция вернёт ключ первого найденного элемента, если значение needle встречается в массиве haystack больше одного раза. Ключи всех совпадающих значений умеет находить функция array_keys() при вызове с необязательным аргументом filter_value.

Внимание

Функция возвращает как логическое значение false, так и нелогическое значение, которое приводится к false. Прочитайте раздел «Логический тип», чтобы получить дополнительную информацию. Используйте оператор === для проверки значения, которое возвращает функция.

Примеры

Пример #1 Пример получения ключа первого найденного элемента функцией array_search()

<?php

$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');

$key = array_search('green', $array); // Значение переменной $key равно 2;
print_r($key);

$key = array_search('red', $array);   // Значение переменной $key равно 1;
print_r($key);

?>

Смотрите также

array_keys() - Возвращает все или некоторое подмножество ключей массива
array_values() - Возвращает значения массива
array_key_exists() - Проверяет, содержит ли массив ключ или индекс
in_array() - Проверяет, содержится ли значение в массиве