key
(PHP 4, PHP 5, PHP 7, PHP 8)
key — 從關聯陣列中取得鍵名
說明
key(array|object
$array): int|string|nullkey() 返回陣列中目前單元的鍵名。
參數
-
array -
該陣列。
返回值
key() 函式返回陣列中內部指針指向的當前單元的鍵名。
但它不會移動指針。如果內部指針超過了元素列表尾部，或者陣列是空的，key() 會返回 null。
更新日誌
| 版本 | 說明 |
|---|---|
| 8.1.0 | 棄用在 object 上呼叫此函式。 在 object 優先使用 get_mangled_object_vars() 或者使用 ArrayIterator。 |
範例
示例 #1 key() 例子
<?php
$array = array(
'fruit1' => 'apple',
'fruit2' => 'orange',
'fruit3' => 'grape',
'fruit4' => 'apple',
'fruit5' => 'apple');
// 此循環將會輸出陣列中所有值等於 「apple」 的鍵（key）
while ($fruit_name = current($array)) {
if ($fruit_name == 'apple') {
echo key($array), "\n";
}
next($array);
}
?>
以上例程會輸出：
fruit1 fruit4 fruit5