Опис

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

key() returns the index element of the current array position.

Параметри

array: The array.

Значення, що повертаються

The key() function simply returns the key of the array element that's currently being pointed to by the internal pointer. It does not move the pointer in any way. If the internal pointer points beyond the end of the elements list or the array is empty, key() returns null.

Журнал змін

Версія	Опис
8.1.0	Виклик цієї функції для об'єктів є застарілим. Краще перетворити object в array, застосувавши get_mangled_object_vars(), або використати методи класу, який імплементує Iterator, наприклад ArrayIterator.
7.4.0	Примірники класів SPL тепер розглядаються як порожні об'єкти, які не мають властивостей, замість виклику метода інтерфейсу Iterator з такою ж назвою, як і в цієї функції.

Приклади

Приклад #1 key() example

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

// this cycle echoes all associative array
// key where value equals "apple"
while ($fruit_name = current($array)) {
    if ($fruit_name == 'apple') {
        echo key($array), "\n";
    }
    next($array);
}
?>

Поданий вище приклад виведе:

fruit1
fruit4
fruit5

Прогляньте також

current() - Return the current element in an array
next() - Advance the internal pointer of an array
array_key_first() - Gets the first key of an array
foreach