array_key_first

(PHP 7 >= 7.3.0, PHP 8)

array_key_firstRecupera la primera clave de un array

Descripción

array_key_first(array $array): int|string|null

Recupera la primera clave del array array dado sin afectar el puntero interno del array.

Parámetros

array

Un array.

Valores devueltos

Devuelve la primera clave de array si el array no está vacío; null en caso contrario.

Ejemplos

Ejemplo #1 Uso simple de array_key_first()

<?php
$array
= ['a' => 1, 'b' => 2, 'c' => 3];

$firstKey = array_key_first($array);

var_dump($firstKey);
?>

El resultado del ejemplo sería:

string(1) "a"

Notas

Sugerencia

Hay varias maneras de proporcionar esta funcionalidad para versiones anteriores a PHP 7.3.0. Es posible utilizar array_keys(), pero esto es bastante ineficiente. También es posible utilizar reset() y key(), pero esto puede cambiar el puntero interno del array. Una solución eficiente, que no modifica el puntero interno del array, escrita como un polyfill:

<?php
if (!function_exists('array_key_first')) {
function
array_key_first(array $arr) {
foreach(
$arr as $key => $unused) {
return
$key;
}
return
NULL;
}
}
?>

Ver también

  • array_key_last() - Recupera la última clave de un array
  • reset() - Reinicia el puntero interno del array al principio