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.

Функция вернёт первый найденный ключ, если в массиве haystack значение needle встречается больше одного раза. Чтобы вернуть ключи всех найденных значений, вызывают функцию 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;
$key = array_search('red', $array); // $key = 1;

?>

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

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