key

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

keyObtiene una clave de un array

Descripción

key(array $array): mixed

key() devuelve el elemento índice de la posición actual del array.

Parámetros

array

El array.

Valores devueltos

La función key() simplemente devuelve la clave del elemento del array que está apuntando actualmente el puntero interno. No desplaza el puntero de ninguna manera. Si el puntero interno señala más allá del final de la lista de elementos o el array está vacío, key() devuelve null.

Historial de cambios

Versión Descripción
7.0.0 array ahora siempre se pasa por el valor. Antes de esta versión, se pasaba por referencia si era posible, y por el valor de lo contrario.

Ejemplos

Ejemplo #1 Ejemplo de key()

<?php
$array 
= array(
    
'fruta1' => 'manzana',
    
'fruta2' => 'naranja',
    
'fruta3' => 'uva',
    
'fruta4' => 'manzana',
    
'fruta5' => 'manzana');

// Este ciclo muestra todas las claves del array asociativo
// donde el valor equivale a "manzana"
while ($nombre_fruta current($array)) {
    if (
$nombre_fruta == 'manzana') {
        echo 
key($array).'<br />';
    }
    
next($array);
}
?>

El resultado del ejemplo sería:

fruta1<br />
fruta4<br />
fruta5<br />

Ver también