array_key_exists

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

array_key_existsПроверяет, существует ли в массиве заданный ключ или индекс

Описание

array_key_exists(string|int|float|bool|resource|null $key, array $array): bool

Функция array_key_exists() возвращает true, если заданный ключ (key) содержится в массиве. В параметр key разрешено передавать значение, которое допустимо в качестве индекса массива.

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

key

Проверяемое значение.

array

Массив с проверяемыми ключами.

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

Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

Замечание:

Функция array_key_exists() ищет ключи только на первом уровне массива. Внутренние ключи в многомерных массивах найдены не будут.

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

Версия Описание
8.0.0 Параметр key теперь принимает аргументы с типами bool, float, int, null, resource и string.
8.0.0 Передача значения с типом object в параметр array больше не поддерживается.
7.4.0 Передача значения с типом object в параметр array устарела. Для проверки свойвства вместо этой функции вызвают функцию property_exists().

Примеры

Пример #1 Пример использования функции array_key_exists()

<?php

$searchArray
= ['first' => 1, 'second' => 4];
var_dump(array_key_exists('first', $searchArray));

?>

Результат выполнения приведённого примера:

bool(true)

Пример #2 Пример использования функции array_key_exists() с языковой конструкцией isset()

Конструкция языка isset() не возвращает true для ключей массива, которые ассоциированы со значением null, а функция array_key_exists() — возвращает.

<?php

$searchArray
= ['first' => null, 'second' => 4];

var_dump(isset($searchArray['first']));
var_dump(array_key_exists('first', $searchArray));

?>

Результат выполнения приведённого примера:

bool(false)
bool(true)

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

  • isset() - Определяет, объявили ли переменную и отличается ли её значение от null
  • array_keys() - Возвращает все или некоторое подмножество ключей массива
  • in_array() - Проверяет, существует ли значение в массиве
  • property_exists() - Проверяет, есть ли у объекта или класса свойство