(PHP 4 >= 4.0.5, PHP 5, PHP 7)
array_search — Busca un valor determinado en un array y devuelve la primera clave correspondiente en caso de éxito
Busca la needle (aguja) en haystack (pajar).
needleEl valor a buscar.
Nota:
Si
needlees una cadena, la comparación es realizada de forma sensible a mayúsculas y minúsculas.
haystackEl array
strict
Si el tercer parámetro, strict, se define como TRUE
entonces la función array_search() también buscará
elementos idénticos en el
haystack. Esto significa que también realizará una
comparación estricta de tipos de la
needle en el haystack,
ya que los objetos deben ser la misma instancia.
Devuelve la clave de la needle si se encuentra en
el array, o FALSE si no.
Si la needle es encontrada en el haystack
más de una vez, se devuelve la primera clave coincidente. Para devolver las claves de
todos los valores coincidentes, se ha de usar en su lugar array_keys()
con el parámetro opcional search_value.
Esta función puede
devolver el valor booleano FALSE, pero también puede devolver un valor no booleano que se
evalúa como FALSE. Por favor lea la sección sobre Booleanos para más
información. Use el operador
=== para comprobar el valor devuelto por esta
función.
| Versión | Descripción |
|---|---|
| 5.3.0 |
Al igual que con todas las funciones internas de PHP a partir de la versión 5.3.0,
array_search() devuelve NULL si se le pasan parámetros
inválidos.
|
Ejemplo #1 Ejemplo de array_search()
<?php
$array = array(0 => 'azul', 1 => 'rojo', 2 => 'verde', 3 => 'rojo');
$clave = array_search('verde', $array); // $clave = 2;
$clave = array_search('rojo', $array); // $clave = 1;
?>