array_key_exists

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

    array_key_exists — Prüft, ob ein gegebener Schlüssel in einem Array existiert

    Beschreibung

    array_key_exists(string|int|float|bool|resource|null$key, array$array): bool

    array_key_exists() gibt true zurück, wenn key im Array vorhanden ist. key kann jeder für einen Array-Index mögliche Wert sein.

    Parameter-Liste

    key

    Der zu prüfende Wert.

    array

    Ein Array mit den zu prüfenden Schlüsseln.

    Rückgabewerte

    Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

    Hinweis:

    array_key_exists() sucht nur in der ersten Dimension nach Schlüsseln. Verschachtelte Schlüssel in mehrdimensionalen Arrays werden nicht gesucht.

    Changelog

    VersionBeschreibung
    8.0.0 Der Parameter key akzeptiert nun Werte vom Typ bool, float, int, null, resource und string als Argument.

    Beispiele

    Beispiel #1 array_key_exists()-Beispiel

    <?php
    $search_array     = array('erstes' => 1, 'zweites' => 4);
    if (    array_key_exists('erstes', $search_array)) {
    echo     "Das Element 'erstes' ist im Array vorhanden";
    }
    ?>

    Beispiel #2 array_key_exists() vs. isset()

    isset() gibt für Schlüssel eines Arrays, die zu einem null-Wert gehören, nicht true zurück, während array_key_exists() dies tut.

    <?php
    $search_array     = array('erstes' => null, 'zweites' => 4);

    // Gibt false zurück
    isset($search_array['erstes']);

    // Gibt true zurück
    array_key_exists('erstes', $search_array);
    ?>

    Anmerkungen

    Hinweis:

    Aus Gründen der Abwärtskompatibilität gibt array_key_exists() auch dann true zurück, wenn key eine Eigenschaft ist, die in einem Objekt definiert ist, das als array übergeben wurde. Dieses Verhalten ist seit PHP 7.4.0 veraltet und seit PHP 8.0.0 entfernt.

    Um zu prüfen, ob eine Eigenschaft in einem Objekt existiert, sollte property_exists() verwendet werden.

    Siehe auch

    • isset() - Prüft, ob eine Variable deklariert ist und sich von null unterscheidet
    • array_keys() - Liefert alle Schlüssel oder eine Teilmenge aller Schlüssel eines Arrays
    • in_array() - Prüft, ob ein Wert in einem Array existiert
    • property_exists() - Prüft, ein Objekt oder eine Klasse auf die angegebene Eigenschaft
    To Top