array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'de', ), 'this' => array ( 0 => 'function.array-find-key.php', 1 => 'array_find_key', 2 => 'Returns the key of the first element satisfying a callback function', ), 'up' => array ( 0 => 'ref.array.php', 1 => 'Array Funktionen', ), 'prev' => array ( 0 => 'function.array-find.php', 1 => 'array_find', ), 'next' => array ( 0 => 'function.array-flip.php', 1 => 'array_flip', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/array/functions/array-find-key.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

array_find_key

(PHP 8 >= 8.4.0)

array_find_key — Returns the key of the first element satisfying a callback function

Beschreibung

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

array_find_key() returns the key of the first element of an Array for which the given callback returns true. If no matching element is found the function returns null.

Parameter-Liste

array
The Array that should be searched.
callback

The callback function to call to check each element, which must be

callback(mixed $value, mixed $key): bool
If this function returns true, the key is returned from array_find_key() and the callback will not be called for further elements.

Rückgabewerte

The function returns the key of the first element for which the callback returns true. If no matching element is found the function returns null.

Beispiele

Beispiel #1 array_find_key() example

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

// Find the first animal with a name longer than 4 characters.
var_dump(array_find_key($array, function (string $value) {
return strlen($value) > 4;
}));

// Find the first animal whose name begins with f.
var_dump(array_find_key($array, function (string $value) {
return str_starts_with($value, 'f');
}));

// Find the first animal where the array key is the first symbol of the animal.
var_dump(array_find_key($array, function (string $value, $key) {
return $value[0] === $key;
}));

// Find the first animal where the array key matching a RegEx.
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