array_is_list()

array_is_list() — Checks whether a given array is a list.

Built-in function of PHP 8.5. The manual lists it as available in PHP 8 >= 8.1.0. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

Determines if the given array is a list. An array is considered a list if its keys consist of consecutive numbers from 0 to count($array)-1.

Signature

array_is_list(array $array): bool

Parameters

Return value

Returns true if array is a list, false otherwise.

Example

A runnable snippet:

var_dump(array_is_list([])); // true var_dump(array_is_list(['apple', 2, 3])); // true var_dump(array_is_list([0 => 'apple', 'orange'])); // true // The array does not start at 0 var_dump(array_is_list([1 => 'apple', 'orange'])); // false // The keys are not in the correct order var_dump(array_is_list([1 => 'apple', 0 => 'orange'])); // false // Non-integer keys var_dump(array_is_list([0 => 'apple', 'foo' => 'bar'])); // false // Non-consecutive keys var_dump(array_is_list([0 => 'apple', 2 => 'bar'])); // false

See also

array_values()

All PHP 8.5 built-in functions

Reference card built from the PHP manual page array_is_list() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.