key

(PHP 4, PHP 5, PHP 7, PHP 8)

keyEstrae la chiave corrente da un array associativo

Descrizione

key(array &$array): mixed

key() restituisce la chiave corrispondente all'attuale posizione del puntatore interno all'array.

Elenco dei parametri

array

L'array.

Valori restituiti

La funzione key() restituisce la chiave dell'elemento dell'array che è attualmente indicato dal puntatore interno. Non modifica il puntatore. Se il puntatore punta oltre la fine della lista degli elementi, oppure se l'array è vuoto, key() restituisce null.

Esempi

Example #1 esempio di key()

<?php
$array
= array(
'frutto1' => 'mela',
'frutto2' => 'arancia',
'frutto3' => 'uva',
'frutto4' => 'mela',
'frutto5' => 'mela');

// questo ciclo mostra tutte le chiavi
// dell'array associativo che sono uguali a 'mela'
while ($nome_frutto = current($array)( {
if (
$nome_frutto == 'mela') {
echo
key($array).'<br />';
}
next($array);
}
?>

Il precedente esempio visualizzerà:

frutto1<br />
frutto4<br />
frutto5<br />

Vedere anche:

  • current() - Restituisce l'elemento corrente di un array
  • next() - Incrementa il puntatore interno dell'array

add a note add a note

User Contributed Notes 5 notes

up
371
lhardie
9 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.
up
57
vinob44 at gmail dot com
10 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
?>
up
14
FatBat
12 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.
?>
up
-3
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);
}
up
-9
danielmadsv at gmail dot com
4 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);

?>
To Top