Rechercher une fonction PHP

array_key_exists

Table des matières

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

array_key_exists — Vérifie si une clé existe dans un tableau

Description

bool array_key_exists ( mixed $key , array $array )

array_key_exists() retourne TRUE s'il existe une clé du nom de key dans le tableau array. key peut être n'importe quelle valeur valide d'index de tableau.

  

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és dans les tableaux multi-dimensionnels ne seront pas trouvés.

  

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 le paramètre key est une propriété définie dans un objet, fourni comme paramètre array. Ce comportement ne doit plus être pris en considération, et vous devez vous assure que le paramètre array est un tableau.

Pour vérifier si une propriété existe dans un objet, utilisez la fonction property_exists().

  

Voir aussi

  • isset() - Détermine si une variable est définie 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é

Rechercher une fonction PHP

Document créé le 30/01/2003, dernière modification le 26/10/2018
Source du document imprimé : https://www.gaudry.be/php-rf-function.array-key-exists.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : http://php.net

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut