array_search
(PHP 4 >= 4.0.5, PHP 5, PHP 7)
array_search — Осуществляет поиск данного значения в массиве и возвращает ключ первого найденного элемента в случае удачи
Описание
Ищет в haystack
значение needle
.
Список параметров
-
needle
-
Искомое значение.
Замечание:
Если
needle
является строкой, сравнение происходит с учетом регистра. -
haystack
-
Массив.
-
strict
-
Если третий параметр
strict
установлен вtrue
, то функция array_search() будет искать идентичные элементы вhaystack
. Это означает, что также будут проверяться типыneedle
вhaystack
, а объекты должны быть одним и тем же экземпляром.
Возвращаемые значения
Возвращает ключ для needle
, если он был
найден в массиве, иначе false
.
Если needle
присутствует в
haystack
более одного раза, будет возвращён
первый найденный ключ. Для того, чтобы возвратить ключи для всех
найденных значений, используйте функцию array_keys()
с необязательным параметром search_value
.
Эта функция может возвращать как логическое значение false
, так и значение не типа boolean, которое приводится к 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() - Проверяет, присутствует ли в массиве значение