The 5th Annual China PHP Conference

key

(PHP 4, PHP 5, PHP 7)

key配列からキーを取り出す

説明

mixed key ( array &$array )

key() は、 現在の配列位置における連想配列要素のキーを返します。

パラメータ

array

配列。

返り値

key() 関数は、内部ポインタが現在指している配列要素のキーを返します。 ポインタを移動することはありません。内部ポインタが要素リストの末尾にいる場合や配列が空の場合は key()NULL を返します。

例1 key() の例

<?php
$array 
= array(
    
'fruit1' => 'リンゴ',
    
'fruit2' => 'オレンジ',
    
'fruit3' => 'ブドウ',
    
'fruit4' => 'リンゴ',
    
'fruit5' => 'リンゴ');

// このループは値が "リンゴ" である
// 全ての連想配列のキーを表示します
while ($fruit_name current($array)) {
    if (
$fruit_name == 'リンゴ') {
        echo 
key($array).'<br />';
    }
    
next($array);
}
?>

上の例の出力は以下となります。

fruit1<br />
fruit4<br />
fruit5<br />

参考

add a note add a note

User Contributed Notes 4 notes

up
185
lhardie
3 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
3
vincphil54800 at gmail dot com
7 months ago
If you want to return the key on an associative array to get the first occurence of this array for exemple and if you don't know the key of the element that you search, it's impossible to find it without create you're own fonction, you can use for example :

/**
     * Retourne la premiére clé/valeur d'un tableau (notament utile pour les tableaux associatifs)
     * @param array $tab un tableau
     * @param int $mode 0 => renvoie la premiére valeur du tableau, 1=> renvoie la premiére clé du tableau
     * @return mixed la premiére occurence d'un tableau
     */
    public static function firstKey($tab,$mode = 0)
    {
        foreach($tab as $key=>$values)
        {
            if(is_array($values))
            {
                self::firstKey($values);
            }
            if($mode == 0)
            {
                return $values;
            }
            elseif($mode == 1)
            {
                return $key;           
            }
        }
        return null;
    }
up
38
vinob44 at gmail dot com
3 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
15
FatBat
5 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.
?>
To Top