key

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

    key — Liefert einen Schlüssel eines Arrays

    Beschreibung

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

    key() gibt das Index-Element der aktuellen Position im Array zurück.

    Parameter-Liste

    array

    Das Array.

    Rückgabewerte

    Die Funktion key() gibt lediglich den Schlüssel des Arrayelements zurück, auf das der interne Zeiger gerade zeigt. Der Zeiger wird dabei nicht bewegt. Zeigt der interne Zeiger über das Ende der Elementliste hinaus oder ist das Array leer, gibt key()null zurück.

    Changelog

    VersionBeschreibung
    8.1.0 Bei Objekten ist die Verwendung dieser Funktion veraltet. Stattdessen sollte entweder das Objekt vorher mit get_mangled_object_vars() in ein Array umgewandelt werden oder es sollten die Methoden einer Klasse verwendet werden, die Iterator implementiert, z. B. ArrayIterator.
    7.4.0 Instanzen von SPL-Klassen werden nun wie leere Objekte behandelt, die keine Eigenschaften haben, anstatt die Iterator-Methode aufzurufen, die den gleichen Namen wie diese Funktion hat.

    Beispiele

    Beispiel #1 key()-Beispiel

    <?php
    $array     = array(
    'Frucht1' => 'Apfel',
    'Frucht2' => 'Orange',
    'Frucht3' => 'Traube',
    'Frucht4' => 'Apfel',
    'Frucht5' => 'Apfel');

    // Diese Schleife gibt alle Schlüssel des assoziativen
    // Arrays aus, deren Wert "Apfel" ist.
    while ($fruit_name = current($array)) {
    if (    $fruit_name == 'Apfel') {
    echo     key($array), "\n";
    }
    next($array);
    }
    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    Frucht1 Frucht4 Frucht5

    Siehe auch

    To Top