(PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8)
array_key_exists — Vérifie si une clé existe dans un tableau
Description
array_key_exists(string|int
$key
, array
$array
): bool
Liste de paramètres
-
key
-
Valeur à vérifier.
-
array
-
Un tableau contenant les clés à vérifier.
Valeurs de retour
Cette fonction retourne true
en cas de succès ou false
si une erreur survient.
Note:
array_key_exists() va rechercher, uniquement, dans
les clés de la première dimension. Les clés imbriquées dans les
tableaux multidimensionnels ne seront pas trouvées
Exemples
Exemple #1 Exemple avec array_key_exists()
<?php
$search_array = array('premier' => 1, 'second' => 4);
if (array_key_exists('premier', $search_array)) {
echo "L'élément 'premier' existe dans le tableau";
}
?>
Exemple #2 array_key_exists() et isSet()
isSet() ne retourne pas true
pour les clés de
tableaux qui correspondent à une valeur null
alors que c'est le
cas pour array_key_exists().
<?php
$search_array = array('first' => null, 'second' => 4);
// retourne false
isset($search_array['first']);
// retourne true
array_key_exists('first', $search_array);
?>
Notes
Note:
En raison de compatibilité ascendante, la fonction
array_key_exists() peut aussi retourner true
si
key
est une propriété définie dans un
object, fourni comme paramètre array
.
Ce comportement est obsolète à partir de PHP 7.4.0, et a été retiré
à partir de PHP 8.0.0.
Pour vérifier si une propriété existe dans un objet,
property_exists() devrait être utilisé.
Voir aussi
- isSet() - Détermine si une variable est déclarée et est différente de null
- array_keys() - Retourne toutes les clés ou un ensemble des clés d'un tableau
- in_array() - Indique si une valeur appartient à un tableau
- property_exists() - Vérifie si un objet ou une classe possède une propriété