key

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

keyПолучает ключ текущего элемента массива

Описание

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

Функция key() возвращает ключ элемента, который соответствует текущей позиции внутреннего указателя массива.

Список параметров

array

Массив.

Возвращаемые значения

Функция key() только возвращает ключ элемента, на который в текущий момент указывает внутренний указатель массива, и не сдвигает указатель ни в каком направлении. Функция key() вернёт null, если внутренний указатель сдвинулся за пределы списка элементов или при вызове на пустом массиве.

Список изменений

Версия Описание
8.1.0 Вызов функции на значении с типом object устарел. Объект (object) либо сначала преобразовывают в массив (array) функцией get_mangled_object_vars(), либо пользуются методами класса наподобие ArrayIterator, в котором реализовали интерфейс Iterator.
7.4.0 Экземпляры классов библиотеки SPL теперь вместо вызова метода интерфейса Iterator, название которого аналогично названию этой функции, обрабатываются как пустые объекты без свойств.

Примеры

Пример #1 Пример получения ключа текущего элемента массива функцией key()

<?php

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

// Цикл выведет ключи ассоциативного массива,
// значения которых равны "apple"
while ($fruit_name = current($array)) {
if (
$fruit_name == 'apple') {
echo
key($array), "\n";
}
next($array);
}

Результат выполнения приведённого примера:

fruit1
fruit4
fruit5

Смотрите также

  • current() - Возвращает текущий элемент массива
  • next() - Сдвигает внутренний указатель массива на одну позицию вперёд
  • array_key_first() - Получает первый ключ массива
  • foreach