key

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

key從關(guān)聯(lián)數(shù)組中取得鍵名

說(shuō)明

key(array|object $array): int|string|null

key() 返回?cái)?shù)組中當(dāng)前單元的鍵名。

參數(shù)

array

該數(shù)組。

返回值

key() 函數(shù)返回?cái)?shù)組中內(nèi)部指針指向的當(dāng)前單元的鍵名。 但它不會(huì)移動(dòng)指針。如果內(nèi)部指針超過了元素列表尾部,或者數(shù)組是空的,key() 會(huì)返回 null。

更新日志

版本 說(shuō)明
8.1.0 棄用在 object 上調(diào)用此函數(shù)。 在 object 優(yōu)先使用 get_mangled_object_vars() 或者使用 ArrayIterator。

范例

示例 #1 key() 例子

<?php
$array 
= array(
    
'fruit1' => 'apple',
    
'fruit2' => 'orange',
    
'fruit3' => 'grape',
    
'fruit4' => 'apple',
    
'fruit5' => 'apple');

// 此循環(huán)將會(huì)輸出數(shù)組中所有值等于 “apple” 的鍵(key)
while ($fruit_name current($array)) {
    if (
$fruit_name == 'apple') {
        echo 
key($array), "\n";
    }
    
next($array);
}
?>

以上例程會(huì)輸出:

fruit1
fruit4
fruit5

參見

  • current() - 返回?cái)?shù)組中的當(dāng)前值
  • next() - 將數(shù)組中的內(nèi)部指針向前移動(dòng)一位
  • array_key_first() - 獲取指定數(shù)組的第一個(gè)鍵
  • foreach