array_search

(PHP 4 >= 4.0.5, PHP 5)

array_search — Recherche dans un tableau la clé associée à une valeur

Description

mixed array_search ( mixed $needle , array $haystack [, bool $strict = 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 s'assurera aussi que le type de needle est le même que celui de la valeur trouvée 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, utilisez plutôt la fonction array_keys() avec le paramètre optionnel search_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.

Historique

Version Description

5.3.0 Comme toutes les fonctions internes de PHP depuis 5.3.0, la fonction array_search() retournera NULL si des paramètres invalides sont passés à la fonction.

4.2.0 Avant la version 4.2.0, array_search() retourne NULL en cas d'échec au lieu de FALSE.

Version	Description
5.3.0	Comme toutes les fonctions internes de PHP depuis 5.3.0, la fonction array_search() retournera `NULL` si des paramètres invalides sont passés à la fonction.
4.2.0	Avant la version 4.2.0, array_search() retourne `NULL` en cas d'échec au lieu de `FALSE`.

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;
$key = array_search('red', $array);   // $key = 1;
?>

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