array_find_key

(PHP 8 >= 8.4.0)

array_find_key — Retorna a chave do primeiro elemento que satisfaz uma função de retorno

Descrição

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

array_find_key() retorna a chave do primeiro elemento de um array para o qual a função callback retorna true. Se nenhum elemento correspondente for encontrado, a função retorna null.

Parâmetros

array

O array a ser pesquisado.

callback

A função de retorno a ser chamada para verificar cada elemento, que precisa ter a seguinte assinatura:

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

Se esta função retornar true, a chave é retornada por array_find_key() e a função de retorno não será chamada para os elementos restantes.

Valor Retornado

A função retorna a chave do primeiro elemento para o qual callback retorna true. Se nenhum elemento correspondente for encontrado, a função retorna null.

Exemplos

Exemplo #1 Exemplo de array_find_key()

<?php
$array = [
    'a' => 'cachorro',
    'b' => 'gato',
    'c' => 'vaca',
    'd' => 'pato',
    'e' => 'elefante',
    'f' => 'ganso'
];

// Encontra o primeiro animal com nome mais longo que 4 caracteres.
var_dump(array_find_key($array, function (string $value) {
    return strlen($value) > 4;
}));

// Encontra o primeiro animal cujo nome começa com f.
var_dump(array_find_key($array, function (string $value) {
    return str_starts_with($value, 'f');
}));

// Encontra o primeiro animal onde a chave do array é a primeira letra do animal.
var_dump(array_find_key($array, function (string $value, $key) {
   return $value[0] === $key;
}));

// Encontra o primeiro animal onde o chave do array corresponde a uma expressão regular.
var_dump(array_find_key($array, function ($value, $key) {
   return preg_match('/^([a-f])$/', $key);
}));
?>

O exemplo acima produzirá:

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

Veja Também

array_find() - Retorna um primeiro elemento que satisfaz uma função de retorno
array_all() - Verifica se todos os elementos de um array satisfazem uma função de retorno
array_any() - Verifica se pelo menos um elemento de um array satisfaz uma função de retorno
array_filter() - Filtra elementos de um array utilizando uma função callback
array_reduce() - Reduz um array para um único valor através de um processo iterativo via callback