PHP array_search(): den Schlüssel zu einem Wert finden

array_search($value, $array) liefert den Schlüssel des ersten Elements, das gleich $value ist, oder false, wenn kein Element passt. Weil ein gefundener Schlüssel 0 sein kann, prüfst du das Ergebnis mit !== false, etwa so: if (($key = array_search('pear', $fruits)) !== false).

<?php
$fruits = ['apple', 'pear', 'plum'];

$key = array_search('pear', $fruits);
var_dump($key);

$key = array_search('kiwi', $fruits);
var_dump($key);

$prices = ['apple' => 1.20, 'pear' => 0.90];
echo array_search(0.90, $prices), "\n";   // works with string keys too

Wenn du nur ein Ja oder Nein brauchst, sagt dir in_array() das direkt. array_search() ist für Fälle, in denen du wissen musst, wo der Wert steht, zum Beispiel um ihn zu ändern oder zu entfernen.

Die Falle 0 vs false

Der häufigste array_search()-Bug: Der Wert ist das erste Element, sein Schlüssel ist 0, und if ($key) behandelt 0 als falsch. Der Code sagt „nicht gefunden“ zu einem Wert, der direkt da ist. Vergleiche mit !== false, das nur auf ein echtes false passt.

<?php
$queue = ['Ada', 'Linus', 'Grace'];

if (array_search('Ada', $queue)) {
    echo "Wrong check: found\n";
} else {
    echo "Wrong check: not found\n";      // this runs, key is 0
}

$key = array_search('Ada', $queue);
if ($key !== false) {
    echo "Right check: found at $key\n";
}

!= false hat denselben Bug wie if ($key), weil 0 == false gleich true ist. Nur der strikte Operator unterscheidet die beiden.

Strikte Suche

Wie in_array() vergleicht array_search() mit ==, außer du übergibst true als drittes Argument. Im lockeren Modus findet ein String eine Zahl und null findet 0, was einen Schlüssel liefert, mit dem du nicht gerechnet hast.

<?php
$ids = [10, 20, 30];
var_dump(array_search('20', $ids));         // loose: "20" == 20
var_dump(array_search('20', $ids, true));   // strict: no match

$stock = ['apples' => 5, 'pears' => 0];
var_dump(array_search(null, $stock));       // null == 0: finds 'pears'
var_dump(array_search(null, $stock, true));

Alle Schlüssel mit einem Wert finden

array_search() hört beim ersten Treffer auf. array_keys($array, $value) liefert jeden passenden Schlüssel als Array; füge true für einen strikten Vergleich hinzu. Ein leeres Ergebnis bedeutet keinen Treffer, also gibt es keine Verwechslung von 0 und false.

<?php
$seats = ['A1' => 'free', 'A2' => 'taken', 'A3' => 'free', 'A4' => 'taken'];

echo array_search('free', $seats), "\n";          // first only
print_r(array_keys($seats, 'free', true));       // all of them

$colors = ['red', 'blue', 'red', 'green', 'red'];
echo implode(', ', array_keys($colors, 'red')), "\n";

Ein mehrdimensionales Array mit array_column durchsuchen

array_search() schaut nicht in verschachtelte Arrays. Bei einer Liste von Zeilen ziehst du das gesuchte Feld mit array_column() heraus; die Positionen in dieser Liste entsprechen den Zeilennummern, also ist das Ergebnis der Index der Zeile.

<?php
$users = [
    ['id' => 101, 'name' => 'Ada',   'email' => 'ada@example.com'],
    ['id' => 102, 'name' => 'Linus', 'email' => 'linus@example.com'],
    ['id' => 103, 'name' => 'Grace', 'email' => 'grace@example.com'],
];

$i = array_search('linus@example.com', array_column($users, 'email'), true);
if ($i !== false) {
    echo "Found {$users[$i]['name']} with id {$users[$i]['id']}\n";
}

// When rows are looked up often, index them once by the field instead
$byEmail = array_column($users, null, 'email');
echo $byEmail['grace@example.com']['id'], "\n";

array_column() nummeriert seine Ausgabe ab 0 neu, also passt das nur, wenn die Zeilen lückenlos mit 0, 1, 2 nummeriert sind. Nach unset() oder array_filter() hat die Nummerierung Lücken; rufe vorher array_values() auf die Zeilen auf oder verwende den Lookup über Schlüssel in den letzten zwei Zeilen. array_column() zeigt mehr zur Form mit Index-Schlüssel.

Suche ohne Groß- und Kleinschreibung

array_search() vergleicht Strings exakt. Wandle beide Seiten in Kleinbuchstaben um, um die Schreibweise zu ignorieren. array_map() behält die Schlüssel, also ist der zurückgegebene Schlüssel der Schlüssel im ursprünglichen Array.

<?php
$tags = ['first' => 'PHP', 'second' => 'Laravel', 'third' => 'MySQL'];

var_dump(array_search('mysql', $tags, true));

$lower = array_map('strtolower', $tags);
$key = array_search(strtolower('mysql'), $lower, true);
var_dump($key);
echo $tags[$key], "\n";

Suchen und ersetzen oder entfernen

Meist sucht man, um mit dem gefundenen Element etwas zu tun. Mit dem Schlüssel in der Hand weist du etwas zu, um es zu ändern, oder rufst unset() auf, um es zu entfernen, und sicherst immer vorher mit !== false ab: unset($arr[false]) entfernt still das Element mit dem Schlüssel 0.

<?php
$todo = ['buy milk', 'call Ada', 'write report'];

$key = array_search('call Ada', $todo, true);
if ($key !== false) {
    $todo[$key] = 'call Ada (done)';
}

$key = array_search('buy milk', $todo, true);
if ($key !== false) {
    unset($todo[$key]);
}

$todo = array_values($todo);   // renumber after unset
print_r($todo);