key

    (PHP 4, PHP 5, PHP 7, PHP 8)

    key — Retourne une clé d'un tableau associatif

    Description

    key(array|object$array): int|string|null

    key() retourne la clé courante dans le tableau array.

    Liste de paramètres

    array

    Le tableau.

    Valeurs de retour

    La fonction key() retourne simplement la clé de l'élément du tableau qui est actuellement pointée par le pointeur interne. Cette fonction ne modifie en aucun cas la position de ce pointeur. Si le pointeur interne pointe un élément se situant après la fin de la liste des éléments, ou bien si le tableau est vide, la fonction key() retournera null.

    Historique

    VersionDescription
    8.1.0 Soit convertir l'objet en un tableau en utilisant get_mangled_object_vars() d'abord, ou utiliser les méthodes fournies par une classe qui implémente Iterator, telle que ArrayIterator.
    7.4.0 À partir de PHP 7.4.0, les instances de classes SPL sont traitées comme des objets vides sans propriétés au lieu d'appeler la méthode Iterator avec le même nom que cette fonction.

    Exemples

    Exemple #1 Exemple avec key()

    <?php
    $array     = array(
    'fruit1' => 'apple',
    'fruit2' => 'orange',
    'fruit3' => 'grape',
    'fruit4' => 'apple',
    'fruit5' => 'apple');

    // Cette boucle affiche toutes les clés
    // dont la valeur vaut "apple"
    while ($fruit_name = current($array)) {
    if (    $fruit_name == 'apple') {
    echo     key($array), "\n";
    }
    next($array);
    }
    ?>

    L'exemple ci-dessus va afficher :

    fruit1 fruit4 fruit5

    Voir aussi

    To Top