array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'fr', ), 'this' => array ( 0 => 'function.list.php', 1 => 'list', 2 => 'Assigne des variables comme si elles étaient un tableau', ), 'up' => array ( 0 => 'ref.array.php', 1 => 'Fonctions sur les tableaux', ), 'prev' => array ( 0 => 'function.ksort.php', 1 => 'ksort', ), 'next' => array ( 0 => 'function.natcasesort.php', 1 => 'natcasesort', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'fr', 'path' => 'reference/array/functions/list.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

list

(PHP 4, PHP 5, PHP 7, PHP 8)

list — Assigne des variables comme si elles étaient un tableau

Description

list(mixed $var, mixed ...$vars = ?): array

Tout comme array(), list() n'est pas une véritable fonction, mais un élément de langage, qui permet de rassembler les variables varname, ... sous forme de tableau, pour les assigner en une seule ligne. Seuls les tableaux et les objets qui implémentent ArrayAccess peuvent être déstructurés. Les expressions list() ne peuvent pas être complètement vides.

Note:

Antérieur à PHP 7.1.0, list() fonctionne uniquement sur un tableau d'indice numérique et suppose que l'indice numérique commence à 0.

À partir de PHP 7.1.0, list() peut également contenir des clés explicites, permettant ainsi la déstructuration de tableaux avec des clés non entières ou non séquentielles. Pour plus de détails sur la déstructuration de tableaux, voir la section sur la déstructuration des tableaux.

Note:

Tenter d’accéder à une clé de tableau qui n’a pas été définie est équivalent à accéder à toute autre variable non définie : un message d’erreur de niveau E_WARNING (E_NOTICE avant PHP 8.0.0) sera émis, et le résultat sera null.

Tenter de déstructurer un scalaire affecte null à toutes les variables. Tenter de déstructurer un objet qui n’implémente pas ArrayAccess est une erreur fatale.

Liste de paramètres

var

Une variable.

vars

Variables supplémentaires.

Valeurs de retour

Retourne le tableau assigné.

Historique

Version Description
7.3.0 Le support pour l'assignement par référence dans la déstructuration de tableau a été ajouté.
7.1.0 Il est maintenant possible de spécifier les clés dans la list(). Cela permet de déstructurer des tableaux avec des clés non-entières ou non séquentielles.

Exemples

Exemple #1 Exemple avec list()

<?php

$info = array('coffee', 'brown', 'caffeine');

// Liste toutes les variables
list($drink, $color, $power) = $info;
echo "$drink is $color and $power makes it special.\n";

// Liste certaines variables
list($drink, , $power) = $info;
echo "$drink has $power.\n";

// Ou bien, n'utilisons que le troisième
list( , , $power) = $info;
echo "I need $power!\n";

// list() ne fonctionne pas avec les chaînes de caractères
list($bar) = "abcde";
var_dump($bar); // NULL
?>

Exemple #2 Exemple d'utilisation de list()

<?php
$result = $pdo->query("SELECT id, name FROM employees");
while (list($id, $name) = $result->fetch(PDO::FETCH_NUM)) {
echo "id: $id, name: $name\n";
}
?>

Exemple #3 Utilisation d'un sous-list()

<?php

list($a, list($b, $c)) = array(1, array(2, 3));

var_dump($a, $b, $c);

?>

L'exemple ci-dessus va afficher :

int(1)
int(2)
int(3)

L'ordre dans lequel les indices d'un tableau à traiter par list() sont définis est non pertinent.

Exemple #4 list() et l'ordre de définition des index

<?php
$foo = array(2 => 'a', 'foo' => 'b', 0 => 'c');
$foo[1] = 'd';
list($x, $y, $z) = $foo;
var_dump($foo, $x, $y, $z);

Étant donné la sortie suivante (notez l'ordre des éléments comparés et dans quel ordre ils ont été écrits dans la syntaxe de la list()) : 

array(4) {
  [2]=>
  string(1) "a"
  ["foo"]=>
  string(1) "b"
  [0]=>
  string(1) "c"
  [1]=>
  string(1) "d"
}
string(1) "c"
string(1) "d"
string(1) "a"

Exemple #5 list() avec des clés

À partir de PHP 7.1.0 list() peut maintenant contenir également des clés explicites, qui peuvent être donnés comme des expressions arbitraires. Le mixage des clés entier et chaîne de caractères est autorisé; Toutefois, les éléments avec et sans clés ne peuvent pas être mélangés.

<?php
$data = [
["id" => 1, "name" => 'Tom'],
["id" => 2, "name" => 'Fred'],
];
foreach ($data as ["id" => $id, "name" => $name]) {
echo "id: $id, name: $name\n";
}
echo PHP_EOL;
list(1 => $second, 3 => $fourth) = [1, 2, 3, 4];
echo "$second, $fourth\n";

L'exemple ci-dessus va afficher :

id: 1, name: Tom
id: 2, name: Fred

2, 4

Voir aussi