PHP 8.4.1 Released!

array_find_key

(PHP 8 >= 8.4.0)

array_find_keyRetourne la clé du premier élément validant la fonction de rappel

Description

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

array_find_key() retourne la clé du premier élément d'un tableau pour lequel la fonction de rappel callback retourne true. Si aucun élément n'est trouvé, la fonction retourne null.

Liste de paramètres

array
Le tableau à parcourir.
callback

La fonction de rappel à utiliser, qui doit respecter la signature suivante

callback(mixed $value, mixed $key): bool
Si cette fonction retourne true, la clé de l'élément sera retournée par array_find_key() et la fonction de rappel ne sera pas appelée pour les autres éléments.

Valeurs de retour

La fonction retourne la clé du premier élément pour lequel la fonction de rappel callback retourne true. Si aucun élément n'est trouvé, la fonction retourne null.

Exemples

Exemple #1 Exemple avec array_find_key()

<?php
$array
= [
'a' => 'chien',
'b' => 'vache',
'c' => 'chat',
'd' => 'canard',
'e' => 'oie',
'f' => 'éléphant'
];

// Trouver la clé du premier animal dont le nom comporte plus de 5 caractères.
var_dump(array_find_key($array, function (string $value) {
return
strlen($value) > 5;
}));

// Trouver la clé du premier animal dont le nom commence par f.
var_dump(array_find_key($array, function (string $value) {
return
str_starts_with($value, 'f');
}));

// Trouver la clé du premier animal qui est aussi la première lettre de son nom.
var_dump(array_find_key($array, function (string $value, $key) {
return
$value[0] === $key;
}));

// Trouver la clé du premier animal validant une RegEx.
var_dump(array_find_key($array, function ($value, $key) {
return
preg_match('/^([a-f])$/', $key);
}));
?>

L'exemple ci-dessus va afficher :

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

Voir aussi

  • array_find() - Retourne le premier élément validant la fonction de rappel
  • array_all() - Vérifie si tous les éléments du tableau valident la fonction de rappel
  • array_any() - Vérifie qu'au moins un élément du tableau valide la fonction de rappel
  • array_filter() - Filtre les éléments d'un tableau grâce à une fonction de rappel
  • array_reduce() - Réduit itérativement un tableau
add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top