Du bist hier: Tips » Scripte » PHP
PHP
Referenzliste

array_search

Array-Funktionen

    Befehl:
mixed array_search ( mixed $needle, array $haystack [, bool $strict] )


    Parameter-Liste:
NameBeschreibung
needleDer zu suchende Wert.

Hinweis:
Wenn needle ein String ist, wird der Vergleich unter Berücksichtigung der Gross-/Kleinschreibung vorgenommen.


Wenn needle ein String ist, wird der Vergleich unter Berücksichtigung der Gross-/Kleinschreibung vorgenommen.
haystackDas Array.
strictIst der dritte Parameter strict auf TRUE gesetzt, so wird array_search() nach identischen Elementen in haystack suchen. Das bedeutet, dass ebenfalls der Typ von needle dem in haystack entsprechen muss 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 search_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.



    Beschreibung:
Die Funktion array_search() sucht in einem Array (haystack) nach einem Wert(needle). Ist der Wert needle in dem Array enthalten, liefert die Funktion den Schlüssel des Elements als Ergebnis zurück.

Kann die Funktion den gesuchten Wert nicht finden, gibt sie als Ergebnis False zurück.

Hat der Parameter strict den Wert True, sucht die Funktion nur Elemente, deren Wert denselben Datentyp hat wie needle, Default-Wert ist False.


    Aktiv in Version:
(PHP 4 >= 4.0.5, PHP 5, PHP 7)

    Siehe auch:
Liefert alle Schlüssel oder eine Teilmenge aller Schlüssel eines Arrays
 
Liefert alle Werte eines Arrays
 
Prüft, ob ein Schlüssel in einem Array existiert
 
Prüft, ob ein Wert in einem Array existiert
 

array_search() - Beispiel:


Eingabe:
<?PHP
$array= array ( 'a' => 'PHP', 'b' => 'ASP', 'c' => 'PERL');

if ( $x = array_search ( 'PHP', $array ) )
{
    echo $array[$x] . ' wurde gefunden!';
}
?>


Ausgabe:
PHP wurde gefunden!

Beschreibung:
Version Beschreibung
4.2.0 Vor PHP 4.2.0 gibt array_search() im Fehlerfall NULL statt FALSE zurück.
array_search() - Beispiel 2:


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

$key = array_search('grün', $array);  // $key = 2;
$key = array_search('rot', $array);   // $key = 1;
?>


Beschreibung:
Version Beschreibung
4.2.0 Vor PHP 4.2.0 gibt array_search() im Fehlerfall NULL statt FALSE zurück.
Array-Funktionen