array_key_exists

(PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8)

array_key_exists — 检查数组里是否有指定的键名或索引

说明

array_key_exists(string|int $key, array $array): bool

数组里有键 key 时，array_key_exists() 返回 true。 key 可以是任何能作为数组索引的值。

参数

key

要检查的键。

array

一个数组，包含待检查的键。

返回值

成功时返回 true， 或者在失败时返回 false。

注意:

array_key_exists() 仅仅搜索第一维的键。 多维数组里嵌套的键不会被搜索到。

范例

示例 #1 array_key_exists() 例子

<?php
$search_array = array('first' => 1, 'second' => 4);
if (array_key_exists('first', $search_array)) {
    echo "The 'first' element is in the array";
}
?>

示例 #2 array_key_exists() 与 isset() 的对比

isset() 对于数组中为 null 的值不会返回 true，而 array_key_exists() 会。

<?php
$search_array = array('first' => null, 'second' => 4);

// 返回 false
isset($search_array['first']);

// 返回 true
array_key_exists('first', $search_array);
?>

注释

注意:

由于为了兼容以前版本，如果 object 当做 array 传入 array_key_exists()，同时 key 是对象的属性，也会返回 true。 此行为在 PHP 7.4.0 弃用且在 PHP 8.0.0 移除。

要检查对象是否有某个属性，应该使用 property_exists()。

参见

  • isset() - 检测变量是否已声明并且其值不为 null
  • array_keys() - 返回数组中部分的或所有的键名
  • in_array() - 检查数组中是否存在某个值
  • property_exists() - 检查对象或类是否具有该属性