PHP | list() Function

The list() function is an inbuilt function in PHP which is used to assign array values to multiple variables at a time. This function will only work on numerical arrays. When the array is assigned to multiple values, then the first element in the array is assigned to the first variable, second to the second variable and so on, till the number of variables. The number of variables cannot exceed the length of the numerical array.

Syntax:

list($variable1, $variable2....)

Parameter: It accepts a list of variables separated by spaces. These variables are assigned values. The first variable is mandatory.

Return Value: The function returns the assigned array to the multiple variables passed. It does not assign a value to the $variableM if m>n, where n is the length of the array.

Below programs illustrate the list() function in PHP:

Program 1: Program to demonstrate the use of list() function.

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
// PHP program to demonstrate the use of list() function 
$array = array(1, 2, 3, 4);
  
// assign array values to variables 
list($a, $b, $c) = $array
  
// print all assigned values 
echo "a =", ($a), "\n";
echo " b =", ($b), "\n";
echo " c =", ($c), "\n"
  
// perform multiplication of
// those assigned numbers
echo "a*b*c =", ($a*$b*$c); 
  
?>

chevron_right


Output:

 a =1
 b =2
 c =3
a*b*c =6

Program 2: Program to demonstrate the runtime error of list() function.

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
// PHP program to demonstrate the 
// runtime error of list() function 
$array = array(1, 2, 3, 4);
  
// assign array values to variables 
list($a, $b, $c, $d, $e) = $array
  
?>

chevron_right


Output:

PHP Notice:  Undefined offset: 4 in 
/home/619f1441636b952bbd400f1e9e8e3d0c.php on line 6

Reference:
http://php.net/manual/en/function.list.php



My Personal Notes arrow_drop_up

Striver(underscore)79 at Codechef and codeforces D

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.




Article Tags :
Practice Tags :


Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.