array_search

(PHP 4 >= 4.0.5, PHP 5)

array_search — Осуществляет поиск данного значения в массиве и возвращает соответствующий ключ в случае удачи

Описание

mixed array_search ( mixed $needle , array $haystack [, bool $strict = false ] )

Ищет в haystack значение needle.

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

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

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

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

Возвращает ключ для needle, если он был найден в массиве, иначе FALSE.

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

Внимание

Эта функция может возвращать как boolean FALSE, так и не-boolean значение, которое приводится к FALSE. За более подробной информацией обратитесь к разделу Булев тип. Используйте оператор === для проверки значения, возвращаемого этой функцией.

Список изменений

Версия	Описание
4.2.0	До PHP 4.2.0, array_search() при неудаче возвращал `NULL` вместо `FALSE`.

Примеры

Пример #1 Пример использования array_search()


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

$key = array_search('green', $array); // $key = 2;
$key = array_search('red', $array);   // $key = 1;
?>

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

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