array_key_exists

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

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

Beschreibung

array_key_exists ( mixed $key , array $array ) : bool

array_key_exists() gibt TRUE zurück, wenn key in dem 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. Im Fehlerfall wird FALSE zurückgegeben.

Hinweis:

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

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 in dem Array vorhanden";
}
?>

Beispiel #2 array_key_exists() vs. isset()

isset() gibt nicht TRUE zurück für Schlüssel eines Arrays, die zu einem NULL-Wert gehören, array_key_exists() tut dies hingegen.

<?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, das als array übergeben wurde, definiert ist. Auf dieses Verhalten sollte man sich nicht verlassen, und es sollte darauf geachtet werden, dass array ein Array ist.

Um zu prüfen, ob eine Eigenschaft in einem Objekt existiert, verwenden Sie property_exists().

Siehe auch

  • isset() - Prüft, ob eine Variable existiert und ob sie nicht NULL ist
  • 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 auf die Existenz einer Eigenschaft eines Objektes bzw. einer Klasse