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

Version	Beschreibung
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

current() - Liefert das aktuelle Element eines Arrays
next() - Rückt den internen Arrayzeiger vor
array_key_first() - Ermittelt den ersten Schlüssel eines Arrays
foreach

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 notes

down

414

lhardie ¶

10 years ago

Note that using key($array) in a foreach loop may have unexpected results.  

When requiring the key inside a foreach loop, you should use:
foreach($array as $key => $value)

I was incorrectly using:
<?php
foreach($array as $value)
{
  $mykey = key($array);
}
?>

and experiencing errors (the pointer of the array is already moved to the next item, so instead of getting the key for $value, you will get the key to the next value in the array)

CORRECT:
<?php
foreach($array as $key => $value)
{
  $mykey = $key;
}

A noob error, but felt it might help someone else out there.

down

vinob44 at gmail dot com ¶

11 years ago

Suppose if the array values are in numbers and numbers contains `0` then the loop will be terminated. To overcome this you can user like this

<?php
$array = array(
    '0' => '5',
    '1' => '2',
    '2' => '0',
    '3' => '3',
    '4' => '1');

// wrong approach

while ($fruit_name = current($array)) {

        echo key($array).'<br />';
       next($array);
}

// the way will be break loop when arra('2'=>0) because its value is '0', while(0) will terminate the loop

// correct approach
while ( ($fruit_name = current($array)) !== FALSE ) {

        echo key($array).'<br />';
       next($array);
}
//this will work properly
?>

down

FatBat ¶

13 years ago

Needed to get the index of the max/highest value in an assoc array.
max() only returned the value, no index, so I did this instead.

<?php
reset($x);   // optional.
arsort($x);
$key_of_max = key($x);   // returns the index.
?>

＋add a note