array_key_exists

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

array_key_exists — 指定したキーまたは添字が配列にあるかどうかを調べる

説明

指定した key が配列に設定されている場合、 array_key_exists() は true を返します。 key は配列添字として使用できる全ての値を使用可能です。

パラメータ

key: 調べる値。
array: キーが存在するかどうかを調べたい配列。

戻り値

成功した場合に true を、失敗した場合に false を返します。

注意:
array_key_exists() は、最初のレベルのキーだけを捜します。多次元配列のネストされたキーは、この関数では見つけられません。

変更履歴

バージョン	説明
8.0.0	`key` パラメータは bool , float , int , null , resource , and string を引数として受け入れるようになりました。
8.0.0	`array` に object を渡すことは、サポートされなくなりました。
7.4.0	`array` に object を渡すことは、推奨されなくなりました。 property_exists() を代わりに使ってください。

例

例1 array_key_exists() の例

<?php
$searchArray = ['first' => 1, 'second' => 4];
var_dump(array_key_exists('first', $searchArray));
?>

上の例の出力は以下となります。

bool(true)

例2 array_key_exists() 対 isset()

isset() は null 値を持つ配列キーに対して true を返しません。一方、array_key_exists() は true を返します。

<?php
$searchArray = ['first' => null, 'second' => 4];

var_dump(isset($searchArray['first']));
var_dump(array_key_exists('first', $searchArray));
?>

上の例の出力は以下となります。

bool(false)
bool(true)

参考

isset() - 変数が宣言されていること、そして null とは異なることを検査する
array_keys() - 配列のキーすべて、あるいはその一部を返す
in_array() - 配列に値があるかチェックする
property_exists() - オブジェクトもしくはクラスにプロパティが存在するかどうかを調べる

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

+add a note

User Contributed Notes 3 notes

down

Rumour ¶

2 years ago

In PHP7+ to find if a value is set in a multidimensional array with a fixed number of dimensions, simply use the Null Coalescing Operator: ??

So for a three dimensional array where you are not sure about any of the keys actually existing

<?php

// instead of:
$exists = array_key_exists($key1, $arr) && array_key_exists($key2, $arr[$key1]) && array_key_exists($key3, $arr[$key1][$key2]) ;

// use:
$exists = array_key_exists($key3, $arr[$key1][$key2]??[]) ;

?>

down

Julian ¶

2 years ago

When you want to check multiple array keys: 

<?php

$array = [];
$array['a'] = '';
$array['b'] = '';
$array['c'] = '';
$array['d'] = '';
$array['e'] = '';

// all given keys a,b,c exists in the supplied array
var_dump(array_keys_exists(['a','b','c'], $array)); // bool(true)

function array_keys_exists(array $keys, array $array): bool
{
 $diff = array_diff_key(array_flip($keys), $array);
 return count($diff) === 0;
}

down

-1

developerxyz852 at gmail dot com ¶

7 months ago

<?php

// Define an associative array
$userProfile = [
 'name' => 'John Doe',
 'email' => 'john.doe@example.com',
 'age' => 30,
 'country' => 'USA'
];

// Key to check
$keyToCheck = 'email';

// Use array_key_exists to check if the key exists in the array
if (array_key_exists($keyToCheck, $userProfile)) {
 echo "The key '$keyToCheck' exists in the array with value: " . $userProfile[$keyToCheck];
} else {
 echo "The key '$keyToCheck' does not exist in the array.";
}

?>

+add a note