array_find_key

(PHP 8 >= 8.4.0)

array_find_key — Gibt den Schlüssel des ersten Elements zurück, das eine Callback-Funktion erfüllt

Beschreibung

function array_find_key(array $array, callable $callback): mixed

array_find_key() gibt den Schlüssel des ersten Elements eines Arrays zurück, für das die übergebene callback-Funktion true zurückgibt. Wenn kein passendes Element gefunden wird, gibt die Funktion null zurück.

Parameter-Liste

array

Das zu durchsuchende Array.

callback

Die Callback-Funktion, die zur Prüfung jedes Elements aufgerufen wird und die folgende Signatur haben muss:

function callback(mixed $value, mixed $key): bool

Wenn diese Funktion true zurückgibt, wird der Schlüssel von array_find_key() zurückgegeben und die Callback-Funktion wird für weitere Elemente nicht mehr aufgerufen.

Rückgabewerte

Die Funktion gibt den Schlüssel des ersten Elements zurück, für das callback true zurückgibt. Wenn kein passendes Element gefunden wird, gibt die Funktion null zurück.

Beispiele

Beispiel #1 array_find_key()-Beispiel

<?php
$array = [
    'a' => 'dog',
    'b' => 'cat',
    'c' => 'cow',
    'd' => 'duck',
    'e' => 'goose',
    'f' => 'elephant'
];

// Findet das erste Tier mit einem Namen, der länger als 4 Zeichen ist.
var_dump(array_find_key($array, function (string $value) {
    return strlen($value) > 4;
}));

// Findet das erste Tier, dessen Name mit f beginnt.
var_dump(array_find_key($array, function (string $value) {
    return str_starts_with($value, 'f');
}));

// Findet das erste Tier, bei dem der Array-Schlüssel das erste Zeichen des Tiernamens ist.
var_dump(array_find_key($array, function (string $value, $key) {
   return $value[0] === $key;
}));

// Findet das erste Tier, bei dem der Array-Schlüssel einem regulären Ausdruck entspricht.
var_dump(array_find_key($array, function ($value, $key) {
   return preg_match('/^([a-f])$/', $key);
}));
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

string(1) "e"
NULL
string(1) "c"
string(1) "a"

Siehe auch

array_find() - Gibt das erste Element zurück, das eine Callback-Funktion erfüllt
array_all() - Prüft, ob alle Elemente eines Arrays eine Callback-Funktion erfüllen
array_any() - Prüft, ob mindestens ein Element eines Arrays eine Callback-Funktion erfüllt
array_filter() - Filtert Elemente eines Arrays mittels einer Callback-Funktion
array_reduce() - Reduziert das Array mittels einer Callback-Funktion iterativ auf einen einzigen Wert