array_key_exists

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

array_key_exists — Verifica si una clave existe en un array

Descripción

array_key_exists() devuelve true si existe una clave con el nombre key en el array array. key puede ser cualquier valor válido de índice de array.

Parámetros

key: Valor a verificar.
array: Un array que contiene las claves a verificar.

Valores devueltos

Esta función retorna true en caso de éxito o false si ocurre un error.

Nota:
array_key_exists() buscará, únicamente, en las claves de la primera dimensión. Las claves anidadas en los arrays multidimensionales no serán encontradas

Historial de cambios

Versión	Descripción
8.5.0	Usar null en el parámetro `key` está obsoleto, use un string vacío en su lugar.
8.0.0	El parámetro `key` acepta ahora los argumentos de tipo bool, float, int, null, resource, y string.
8.0.0	Ya no es posible pasar un objeto al parámetro `array`.
7.4.0	Se desaconseja pasar un objeto al parámetro `array`. Utilizar en su lugar property_exists().

Ejemplos

Ejemplo #1 Ejemplo con array_key_exists()

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

El ejemplo anterior mostrará:

bool(true)

Ejemplo #2 array_key_exists() y isset()

isset() no devuelve true para las claves de arrays que corresponden a un valor null mientras que array_key_exists() sí lo hace.

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

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

El ejemplo anterior mostrará:

bool(false)
bool(true)

Ver también

isset() - Determina si una variable está declarada y es diferente de null
array_keys() - Devuelve todas las claves o un conjunto de las claves de un array
in_array() - Indica si un valor pertenece a un array
property_exists() - Verifica si un objeto o una clase posee una propiedad