Descripción

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

key() devuelve la clave actual en el array array.

Parámetros

array: El array.

Valores devueltos

La función key() devuelve simplemente la clave del elemento del array que es actualmente apuntado por el puntero interno. Esta función no modifica en ningún caso la posición de este puntero. Si el puntero interno apunta un elemento situado después del final de la lista de elementos, o bien si el array está vacío, la función key() devolverá null.

Historial de cambios

Versión	Descripción
8.1.0	O bien convertir el object en un array utilizando get_mangled_object_vars() primero, o utilizar los métodos proporcionados por una clase que implemente Iterator, tal como ArrayIterator.
7.4.0	A partir de PHP 7.4.0, las instancias de clases SPL son tratadas como objetos vacíos sin propiedades en lugar de llamar al método Iterator con el mismo nombre que esta función.

Ejemplos

Ejemplo #1 Ejemplo con key()

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

// Este ciclo muestra todas las claves
// cuyo valor es "apple"
while ($fruit_name = current($array)) {
    if ($fruit_name == 'apple') {
        echo key($array), "\n";
    }
    next($array);
}
?>

El ejemplo anterior mostrará:

fruit1
fruit4
fruit5

Ver también

current() - Devuelve el elemento actual del array
next() - Avance el puntero interno de un array
array_key_first() - Recupera la primera clave de un array
foreach