PHP array_search() : trouver la clé d'une valeur

array_search($value, $array) renvoie la clé du premier élément égal à $value, ou false si aucun élément ne correspond. Comme une clé trouvée peut valoir 0, testez le résultat avec !== false, comme dans 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

Si vous n'avez besoin que d'un oui ou d'un non, in_array() le dit directement. array_search() sert quand vous devez savoir où se trouve la valeur, par exemple pour la modifier ou la supprimer.

Le piège 0 ou false

Le bug le plus courant avec array_search() : la valeur est le premier élément, sa clé vaut 0, et if ($key) traite 0 comme faux. Le code dit « non trouvé » pour une valeur qui est bien là. Comparez avec !== false, qui ne correspond qu'à un vrai false.

<?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 a le même bug que if ($key), car 0 == false vaut true. Seul l'opérateur strict les distingue.

Recherche stricte

Comme in_array(), array_search() compare avec == sauf si vous passez true en troisième argument. Le mode souple permet à une chaîne de trouver un nombre et à null de trouver 0, ce qui renvoie une clé inattendue.

<?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));

Trouver toutes les clés d'une valeur

array_search() s'arrête à la première correspondance. array_keys($array, $value) renvoie toutes les clés correspondantes sous forme de tableau ; ajoutez true pour une comparaison stricte. Un résultat vide signifie aucune correspondance, donc pas de confusion entre 0 et 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";

Chercher dans un tableau multidimensionnel avec array_column

array_search() ne regarde pas dans les tableaux imbriqués. Pour une liste de lignes, extrayez le champ recherché avec array_column() ; les positions dans cette liste correspondent aux numéros de ligne, donc le résultat est l'index de la ligne.

<?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() renumérote sa sortie depuis 0, donc cela ne s'aligne que si les lignes sont numérotées 0, 1, 2 sans trou. Après unset() ou array_filter(), la numérotation a des trous ; appliquez d'abord array_values() aux lignes ou utilisez la recherche par clé des deux dernières lignes. array_column() détaille la forme avec clé d'index.

Recherche insensible à la casse

array_search() compare les chaînes exactement. Mettez les deux côtés en minuscules pour ignorer la casse. array_map() garde les clés, donc la clé renvoyée est celle du tableau d'origine.

<?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";

Chercher puis remplacer ou supprimer

La raison habituelle de chercher est d'agir sur l'élément trouvé. Avec la clé en main, affectez-la pour le modifier ou faites unset() pour le supprimer, en vérifiant toujours d'abord !== false : unset($arr[false]) supprime sans prévenir l'élément de clé 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);