array_search

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

array_search — Durchsucht ein Array nach einem Wert und liefert bei Erfolg den zugehörigen Schlüssel

Beschreibung

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

Sucht needle in haystack.

Parameter-Liste

needle: Der zu suchende Wert.

Hinweis:
Wenn needle ein String ist, wird der Vergleich unter Berücksichtigung der Groß-/Kleinschreibung vorgenommen.
haystack: Das Array.
strict: Ist der dritte Parameter strict auf true gesetzt, so wird array_search() nach identischen Elementen in haystack suchen. Das bedeutet, dass ebenfalls ein typstarker Vergleich von needle in haystack durchgeführt wird und die Objekte die selbe Instanz sind.

Rückgabewerte

Gibt den Schlüssel für needle zurück, wenn es gefunden wurde, ansonsten false.

Wenn needle in haystack mehrfach gefunden wurde, so wird der erste passende Schlüssel zurückgegeben. Um die Schlüssel für alle gefundenen Werte zurückzugeben, können Sie stattdessen array_keys() mit dem optionalen Parameter filter_value verwenden.

Warnung

Diese Funktion kann sowohl das boolsche false zurückliefern, als auch einen nicht-boolschen Wert, welcher zu false ausgewertet wird. Weitere Informationen entnehmen Sie bitte dem Abschnitt über die boolschen Typen. Benutzen Sie deshalb den === Operator, um den Rückgabewert dieser Funktion zu überprüfen.

Beispiele

Beispiel #1 array_search()-Beispiel

<?php
$array = array(0 => 'blau', 1 => 'rot', 2 => 'grün', 3 => 'rot');

$key = array_search('grün', $array); // $key = 2;
print_r($key);

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

Siehe auch

array_keys() - Liefert alle Schlüssel oder eine Teilmenge aller Schlüssel eines Arrays
array_values() - Liefert alle Werte eines Arrays
array_key_exists() - Prüft, ob ein gegebener Schlüssel in einem Array existiert
in_array() - Prüft, ob ein Wert in einem Array existiert