array_is_list()


WordPressのarray_is_list()関数は、指定された配列が連続した整数キーのリストであるかどうかを判定するために使用されます。この関数はPHP 8.1.0以降で利用可能です。

構文

array_is_list(array $array): bool
  • $array(array) — チェックする配列。

戻り値:

  • bool — 配列が連続した整数キーのリストであればtrue、そうでなければfalseを返します。

例1: 基本的な使用例

この例では、配列がリストかどうかをチェックします。

<?php $array = [0 => 'a', 1 => 'b', 2 => 'c']; var_dump(array_is_list($array)); // bool(true) ?>

例2: キーが連続していない場合

キーが連続していない場合、array_is_list()はfalseを返します。

<?php $array = [0 => 'a', 2 => 'b', 3 => 'c']; var_dump(array_is_list($array)); // bool(false) ?>

例3: キーが整数でない場合

キーが整数でない場合、array_is_list()はfalseを返します。

<?php $array = ['a' => 'apple', 'b' => 'banana']; var_dump(array_is_list($array)); // bool(false) ?>

例4: 空の配列

空の配列はリストと見なされます。

<?php $array = []; var_dump(array_is_list($array)); // bool(true) ?>

例5: キーが0から始まらない場合

キーが0から始まらない場合、array_is_list()はfalseを返します。

<?php $array = [1 => 'a', 2 => 'b', 3 => 'c']; var_dump(array_is_list($array)); // bool(false) ?>

例6: 混合キーの場合

整数キーと文字列キーが混在している場合、array_is_list()はfalseを返します。

<?php $array = [0 => 'a', 'b' => 'banana']; var_dump(array_is_list($array)); // bool(false) ?>

例7: 順不同のキー

キーが順不同で並んでいる場合、array_is_list()はfalseを返します。

<?php $array = [1 => 'a', 0 => 'b', 2 => 'c']; var_dump(array_is_list($array)); // bool(false) ?>

例8: 負のキー

キーが負の整数の場合、array_is_list()はfalseを返します。

<?php $array = [-1 => 'a', 0 => 'b', 1 => 'c']; var_dump(array_is_list($array)); // bool(false) ?>

注意点:

  • array_is_list()はPHP 8.1.0以降でのみ利用可能です。それ以前のバージョンでは使用できません。
  • この関数は、配列のキーが連続した整数であり、0から始まる場合にのみtrueを返します。

関連機能：