array_search

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

array_search — Busca en un array la primera clave asociada al valor

Descripción

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

Busca needle en haystack.

Parámetros

needle: El valor a buscar.

Nota:
Si needle es un string, la comparación se realiza respetando la casilla.
haystack: El array.
strict: Si el tercer argumento strict es true, entonces array_search() buscará elementos idénticos en haystack. Esto significa que esta función realizará una comparación estricta del tipo de needle en haystack, y que los objetos provienen de la misma instancia.

Valores devueltos

Devuelve la clave para needle si es encontrada en el array, false en caso contrario.

Si needle es encontrado más de una vez en haystack, la primera clave coincidente es devuelta. Para encontrar todas las claves correspondientes, utilice en su lugar la función array_keys() con el argumento opcional filter_value.

Advertencia

Esta función puede retornar false, pero también puede retornar un valor equivalente a false. Por favor, lea la sección sobre los booleanos para más información. Utilice el operador === para probar el valor de retorno exacto de esta función.

Ejemplos

Ejemplo #1 Ejemplo con 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);
?>

Ver también

array_keys() - Devuelve todas las claves o un conjunto de las claves de un array
array_values() - Devuelve todos los valores de un array
array_key_exists() - Verifica si una clave existe en un array
in_array() - Indica si un valor pertenece a un array