array_key_exists
(PHP 4 >= 4.0.7, PHP 5, PHP 7)
array_key_exists — Checks if the given key or index exists in the array
Description
array_key_exists() returns TRUE
if the
given key
is set in the array.
key
can be any value possible
for an array index.
Return Values
Returns TRUE
on success or FALSE
on failure.
Note:
array_key_exists() will search for the keys in the first dimension only. Nested keys in multidimensional arrays will not be found.
Examples
Example #1 array_key_exists() example
<?php
$search_array = array('first' => 1, 'second' => 4);
if (array_key_exists('first', $search_array)) {
echo "The 'first' element is in the array";
}
?>
Example #2 array_key_exists() vs isset()
isset() does not return TRUE
for array keys
that correspond to a NULL
value, while
array_key_exists() does.
<?php
$search_array = array('first' => null, 'second' => 4);
// returns false
isset($search_array['first']);
// returns true
array_key_exists('first', $search_array);
?>
Notes
Note:
For backward compatibility reasons, array_key_exists() will also return
TRUE
ifkey
is a property defined within an object given asarray
. This behaviour should not be relied upon, and care should be taken to ensure thatarray
is an array.To check whether a property exists in an object, use property_exists().
See Also
- isset() - Determine if a variable is declared and is different than NULL
- array_keys() - Return all the keys or a subset of the keys of an array
- in_array() - Checks if a value exists in an array
- property_exists() - Checks if the object or class has a property
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.array-key-exists.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.