HomeMenu
Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

array_find_key

Description

The array_find_key of Array for PHP returns the key of the first element satisfying a callback function.

Syntax

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

Parameters

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.

Return

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

Examples

1 · array callback

<?

function callback(string $value, $key)
{
    return $key === $value[0];
}

$array =
[
    "a" => "dog",
    "b" => "cat",
    "c" => "cow"
];
$callback = "callback";

$return = array_find_key($array, $callback);

var_dump($return);

string(1) "c"