array_search

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

array_search — Recherche dans un tableau la première clé associée à la valeur

Description

array_search(mixed $needle, array $haystack, bool $strict = false): int|string|false

Recherche needle dans haystack.

Liste de paramètres

needle: La valeur à chercher.

Note:
Si needle est une chaîne de caractères, la comparaison est effectuée en respectant la casse.
haystack: Le tableau.
strict: Si le troisième paramètre strict vaut true, alors array_search() cherchera des éléments identiques dans haystack. Cela signifie que cette fonction va effectuer une comparaison stricte du type de needle dans haystack, et que les objets proviennent de la même instance.

Valeurs de retour

Retourne la clé pour needle si elle est trouvée dans le tableau, false sinon.

Si needle est trouvé plus d'une fois dans haystack, la première clé concordante est retournée. Pour trouver toutes les clés correspondantes, utiliser plutôt la fonction array_keys() avec le paramètre optionnel filter_value.

Avertissement

Cette fonction peut retourner false, mais elle peut aussi retourner une valeur équivalent à false. Veuillez lire la section sur les booléens pour plus d'informations. Utilisez l'opérateur === pour tester la valeur de retour exacte de cette fonction.

Exemples

Exemple #1 Exemple avec array_search()

<?php
$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');

$key = array_search('green', $array); // $key = 2;
print_r($key);

$key = array_search('red', $array);   // $key = 1;
print_r($key);
?>

Voir aussi

array_keys() - Retourne toutes les clés ou un ensemble des clés d'un tableau
array_values() - Retourne toutes les valeurs d'un tableau
array_key_exists() - Vérifie si une clé existe dans un tableau
in_array() - Indique si une valeur appartient à un tableau