key
(PHP 4, PHP 5, PHP 7, PHP 8)
key — Liefert einen Schlüssel eines Arrays
Beschreibung
$array
): int|string|nullkey() 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
Version | Beschreibung |
---|---|
8.1.0 | Die Verwendung dieser Funktion bei Objekten ist veraltet. Entweder sollte zuerst get_mangled_object_vars() auf das Objekt angewendet werden oder sollte ArrayIterator verwendet werden. |
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
- current() - Liefert das aktuelle Element eines Arrays
- next() - Rückt den internen Arrayzeiger vor
- array_key_first() - Gets the first key of an array
- foreach