PHP 8.4.0 Alpha 2 available for testing

array_key_first

(PHP 7 >= 7.3.0, PHP 8)

array_key_firstErmittelt den ersten Schlüssel eines Arrays

Beschreibung

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

Ermittelt den ersten Schlüssel von array, ohne den internen Array-Zeiger zu verändern.

Parameter-Liste

array

Ein Array

Rückgabewerte

Gibt den ersten Schlüssel von array zurück, wenn das Array nicht leer ist, andernfalls wird null zurückgegeben.

Beispiele

Beispiel #1 Grundlegende Verwendung von array_key_first()

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

$firstKey = array_key_first($array);

var_dump($firstKey);
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

string(1) "a"

Anmerkungen

Tipp

Es gibt mehrere Möglichkeiten, diese Funktionalität für PHP-Versionen vor 7.3.0 bereitzustellen. Es ist möglich, array_keys() zu verwenden, aber das ist eher ineffizient. Es ist auch möglich, reset() und key() zu verwenden, aber das kann den internen Array-Zeiger verändern. Eine effiziente Lösung, die den internen Array-Zeiger nicht verändert, geschrieben als Polyfill:

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

Siehe auch

  • array_key_last() - Ermittelt den letzten Schlüssel eines Arrays
  • reset() - Setzt den internen Zeiger eines Arrays auf sein erstes Element
add a note

User Contributed Notes 2 notes

up
1
MaxiCom dot Developpement at gmail dot com
7 months ago
A polyfill serves the purpose of retroactively incorporating new features from PHP releases into older PHP versions, ensuring API compatibility.

In PHP 7.3.0, the array_key_first() function was introduced, demonstrated in the following example:

<?php

$array
= [
'first_key' => 'first_value',
'second_key' => 'second_value',
];

var_dump(array_key_first($array));

?>

The provided polyfill in this documentation allows the convenient use of array_key_first() with API compatibility in PHP versions preceding PHP 7.3.0, where the function was not implemented:

<?php

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

$array = [
'first_key' => 'first_value',
'second_key' => 'second_value',
];

var_dump(array_key_first($array));

?>
up
-22
Anonymous
11 months ago
The best way to polyfill array_key_first is:

$first_key = array_keys($array)[0] ?? NULL;
To Top