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.
key
(PHP 4, PHP 5, PHP 7, PHP 8)
key — Retourne une clé d'un tableau associatif
Description
key() retourne la clé courante dans le
tableau array.
Liste de paramètres
-
array -
Le tableau.
Valeurs de retour
La fonction key() retourne simplement la clé
de l'élément du tableau qui est actuellement pointée par le pointeur
interne. Cette fonction ne modifie en aucun cas la position de ce pointeur.
Si le pointeur interne pointe un élément se situant après la fin de la liste
des éléments, ou bien si le tableau est vide, la fonction
key() retournera null.
Historique
| Version | Description |
|---|---|
| 8.1.0 | Soit convertir l'objet en un tableau en utilisant get_mangled_object_vars() d'abord, ou utiliser les méthodes fournies par une classe qui implémente Iterator, telle que ArrayIterator. |
| 7.4.0 | À partir de PHP 7.4.0, les instances de classes SPL sont traitées comme des objets vides sans propriétés au lieu d'appeler la méthode Iterator avec le même nom que cette fonction. |
Exemples
Exemple #1 Exemple avec key()
<?php
$array = array(
'fruit1' => 'apple',
'fruit2' => 'orange',
'fruit3' => 'grape',
'fruit4' => 'apple',
'fruit5' => 'apple');
// Cette boucle affiche toutes les clés
// dont la valeur vaut "apple"
while ($fruit_name = current($array)) {
if ($fruit_name == 'apple') {
echo key($array), "\n";
}
next($array);
}
?>L'exemple ci-dessus va afficher :
fruit1 fruit4 fruit5
Voir aussi
- current() - Retourne l'élément courant du tableau
- next() - Avance le pointeur interne d'un tableau
- array_key_first() - Récupère la première clé d'un tableau
- foreach
add a note
User Contributed Notes 5 notes
lhardie ¶
10 years ago
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
?>
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.
?>
Md Tahazzot ¶
4 years ago
(Editor note: Or just use the array_keys function)
Make as simple as possible but not simpler like this one :)
$k = array();
for($i = 0; $i < count($arr); $i++){
$k[$i] = key($arr);
next($arr);
}
danielmadsv at gmail dot com ¶
5 years ago
In addition to FatBat's response, if you'd like to find out the highest key in an array (assoc or not) but don't want to arsort() it, take a look at this:
<?php
$arr = [ '3' => 14, '1' => 15, '4' => 92, '15' => 65 ];
$key_of_max = array_search( max($arr) , $arr);
?>
