array_is_list
PHP function
Edit on GitHub ✎
(PHP 8 >= 8.1.0)
Checks whether a given array is a list
Description
array_is_list(array $array): bool
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.
Parameters
arrayThe Array being evaluated.
Return Values
Returns true if array is a list, false otherwise.
Examples
array_is_list() example
php
<?php
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
?>Notes
Note
This function returns true on empty arrays.