list

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

list把数组中的值赋给一组变量

说明

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

array() 一样,这不是真正的函数,而是语言结构。 list() 可以在单次操作内为一组变量赋值。字符串不能解包且 list() 表达式不能完全为空。

注意:

在 PHP 7.1.0 之前的版本,list() 仅能用于数字索引的数组,并假定数字索引从 0 开始。

参数

var

一个变量。

vars

更多变量。

返回值

返回指定的数组。

更新日志

版本 说明
7.3.0 支持在数组解构时传引用。
7.1.0 现在可以指定 list() 中的键。 这就可以解构非数字键或者无顺序的数组。

示例

示例 #1 list() 例子

<?php

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

// 列出所有变量
list($drink, $color, $power) = $info;
echo
"$drink is $color and $power makes it special.\n";

// 列出他们的其中一个
list($drink, , $power) = $info;
echo
"$drink has $power.\n";

// 或者让我们跳到仅第三个
list( , , $power) = $info;
echo
"I need $power!\n";

// list() 不能对字符串起作用
list($bar) = "abcde";
var_dump($bar); // NULL
?>

示例 #2 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";
}
?>

示例 #3 使用嵌套的 list()

<?php

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

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

?>
int(1)
int(2)
int(3)

示例 #4 list() 和索引顺序定义

list() 使用 array 索引的顺序和它何时定义无关。

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

得到以下输出(注意比较 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"

示例 #5 带键的 list()

从 PHP 7.1.0 开始,list() 可以包含显式的键,可赋值到任意表达式。 可以混合使用数字和字符串键。但是不能混合有键和无键不能混用。

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

以上示例会输出:

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

2, 4

参见

  • each() - 返回数组中当前的键/值对并将数组指针向前移动一步
  • array() - 新建一个数组
  • extract() - 从数组中将变量导入到当前的符号表