(PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8)
array_key_exists — Checks if the given key or index exists in the array
Description
array_key_exists(string|int $key
, array $array
): bool
Parameters
-
key
-
Value to check.
-
array
-
An array with keys to check.
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 returntrue
ifkey
is a property
defined within an object given as
array
. This behaviour is deprecated as of PHP 7.4.0,
and removed as of PHP 8.0.0.To check whether a property exists in an object,
property_exists() should be used.
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
Julian ¶
2 months 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;
}
manhon824 at gmail dot com ¶
11 years ago
I took hours for me to debug, and I finally recognized that,
You have to reset the $array before using array_key_exists
reset($array);
array_key_exists($needle,$array);
Or you will get no reply.
I was wondering what is the best way to search keys in an array and return it’s value. Something like array_search but for keys. Would a loop be the best way?
Array:
Array([20120425] => 409 [20120426] => 610 [20120427] => 277
[20120428] => 114 [20120429] => 32 [20120430] => 304
[20120501] => 828 [20120502] => 803 [20120503] => 276 [20120504] => 162)
Value I am searching for : 20120504
betabandido
18.8k11 gold badges60 silver badges76 bronze badges
asked May 5, 2012 at 0:19
Keith PowerKeith Power
13.8k22 gold badges66 silver badges132 bronze badges
0
The key is already the … ehm … key
echo $array[20120504];
If you are unsure, if the key exists, test for it
$key = 20120504;
$result = isset($array[$key]) ? $array[$key] : null;
Minor addition:
$result = @$array[$key] ?: null;
One may argue, that @
is bad, but keep it serious: This is more readable and straight forward, isn’t?
Update: With PHP7 my previous example is possible without the error-silencer
$result = $array[$key] ?? null;
answered May 5, 2012 at 0:22
KingCrunchKingCrunch
128k21 gold badges150 silver badges173 bronze badges
3
array_search('20120504', array_keys($your_array));
answered May 5, 2012 at 0:21
1
<?php
// Checks if key exists (doesn't care about it's value).
// @link http://php.net/manual/en/function.array-key-exists.php
if (array_key_exists(20120504, $search_array)) {
echo $search_array[20120504];
}
// Checks against NULL
// @link http://php.net/manual/en/function.isset.php
if (isset($search_array[20120504])) {
echo $search_array[20120504];
}
// No warning or error if key doesn't exist plus checks for emptiness.
// @link http://php.net/manual/en/function.empty.php
if (!empty($search_array[20120504])) {
echo $search_array[20120504];
}
?>
answered May 5, 2012 at 0:31
FleshgrinderFleshgrinder
15.6k4 gold badges47 silver badges55 bronze badges
Here is an example straight from PHP.net
$a = array(
"one" => 1,
"two" => 2,
"three" => 3,
"seventeen" => 17
);
foreach ($a as $k => $v) {
echo "$a[$k] => $v.n";
}
in the foreach you can do a comparison of each key to something that you are looking for
answered May 5, 2012 at 0:23
1
For get last value in multidimensional array and order ascending,
function lastvalue($array, $key)
{
$a = array();
for($i = 0; $i < count($array); $i++){
$a[] = $array[$i][$key];
}
sort($a);
return $a[$i-1];
}
$a=array(
array("row" => 2, "column" => 6),
array("row" => 2, "column" => 3),
array("row" => 2, "column" => 7)
);
echo lastvalue($a, "column"); //result = 7
answered Apr 29, 2021 at 4:01
isset() will return:
–true if the key exists and the value is != NULL
–false if the key exists and value == NULL
–false if the key does not exist
array_key_exists() will return:
–true if the key exists
–false if the key does not exist
So, if your value may be NULL, the proper way is array_key_exists
. If your application doesn’t differentiate between NULL and no key, either will work, but array_key_exists
always provides more options.
In the following example, no key in the array returns NULL, but so does a value of NULL for a given key. That means it’s effectively the same as isset
.
The null coalesce operator(??) wasn’t added until PHP 7, but this works back to PHP 5, maybe 4:
$value = (array_key_exists($key_to_check, $things) ? $things[$key_to_check] : NULL);
as a function:
function get_from_array($key_to_check, $things)
return (array_key_exists($key_to_check,$things) ? $things[$key_to_check] : NULL);
array_key_exists
(PHP 4 >= 4.0.7, PHP 5, PHP 7)
array_key_exists — Проверяет, присутствует ли в массиве указанный ключ или индекс
Описание
bool array_key_exists
( mixed $key
, array $array
)
Список параметров
-
key
-
Проверяемое значение
-
array
-
Массив с проверяемыми ключами
Возвращаемые значения
Возвращает TRUE
в случае успешного завершения или FALSE
в случае возникновения ошибки.
Примеры
Пример #1 Пример использования array_key_exists()
<?php
$search_array = array('first' => 1, 'second' => 4);
if (array_key_exists('first', $search_array)) {
echo "Массив содержит элемент 'first'.";
}
?>
Пример #2 array_key_exists() и isset()
isset() не возвращает TRUE
для ключей массива,
указывающих на NULL
, а
array_key_exists() возвращает.
<?php
$search_array = array('first' => null, 'second' => 4);// возвращает false
isset($search_array['first']);// возвращает true
array_key_exists('first', $search_array);
?>
Примечания
Замечание:
Для обратной совместимости может быть использован следующий устаревший псевдоним:
key_exists()
Замечание:
По причинам обратной совместимости array_key_exists()
возвращаетTRUE
, еслиkey
является свойством
объекта, переданным в качестве параметраarray
.
На это поведение не стоит полагаться, и перед использованием данной функции
необходимо проверять, что параметрarray
имеет тип
array.Чтобы проверить, содержит ли объект какое-либо свойство, используйте функцию
property_exists().
Смотрите также
- isset() – Определяет, была ли установлена переменная значением отличным от NULL
- array_keys() – Возвращает все или некоторое подмножество ключей массива
- in_array() – Проверяет, присутствует ли в массиве значение
- property_exists() – Проверяет, содержит ли объект или класс указанный атрибут
Вернуться к: Функции для работы с массивами
Все функции для работы с массивами
Разберём самые популярные из них.
Создание массива
Создать пустой массив:
$array = [];
// До версии PHP 5.4 массив создавался так (можно и до сих пор встретить в "старом" коде):
$array = array();
Создать массив с элементами:
$array = ['Audi', 'BMW', 'Honda'];
// В "старом" стиле
$array = array('Audi', 'BMW', 'Honda');
При необходимости можно воспользоваться функцией array_fill($start, $size, $value)
, которая создаст массив с количеством $size
элементов со значением $value
, начиная с индекса $start
.
$array = array_fill(0, 3, 'Text');
print_r($array);
Результат:
Array
(
[0] => Text
[1] => Text
[2] => Text
)
Можно воспользоваться функцией explode($delimiter, $string)
, которая из строки $string
создаст массив используя разделитель $delimiter
, в данном случае запятая.
$string = 'Text1,Text2,Text3';
$array = explode(',', $string);
print_r($array);
Результат:
Array
(
[0] => Text1
[1] => Text2
[2] => Text3
)
Наполнение массива (добавление элементов)
// Создаём пустой массив
$array = [];
// Добавляем элементы в массив
$array[] = 'Audi';
$array[] = 'BMW';
$array[] = 'Honda';
print_r($array);
Можно сразу определить ключ (индекс) для значения массива:
$array = [];
$array[] = 'Audi';
$array[] = 'BMW';
$array[] = 'Honda';
$array[5] = 'Jaguar';
$array['lada'] = 'Lada';
print_r($array);
Результат:
Array
(
[0] => Audi
[1] => BMW
[2] => Honda
[5] => Jaguar
[lada] => Lada
)
Функция array_unshift()
добавляет один или несколько элементов в начало массива:
$array = ['Audi', 'BMW', 'Honda'];
array_unshift($array, "Lada", "Mazda");
print_r($array);
Результат:
Array
(
[0] => Lada
[1] => Mazda
[2] => Audi
[3] => BMW
[4] => Honda
)
Функция array_push()
добавляет один или несколько элементов в конец массива:
$array = ['Audi', 'BMW', 'Honda'];
array_push($array, "Lada", "Mazda");
print_r($array);
Результат:
Array
(
[0] => Audi
[1] => BMW
[2] => Honda
[3] => Lada
[4] => Mazda
)
Узнать количество элементов в массиве (Размер массива)
Узнать количество элементов массива (размер массива) можно следующими способами:
// Функция count()
$array = ['Audi', 'BMW', 'Honda'];
$count = count($array);
print_r($count); // 3
// Функция sizeof()
$array = ['Audi', 'BMW', 'Honda'];
$size = sizeof($array);
print_r($size); // 3
Если в функцию count()
вторым параметром передать встроенную в PHP константу COUNT_RECURSIVE
, то мы получим количество элементов массива и всех подмассивов, которые в нём находятся:
$cars = [
'Russian Federation' => [
'Lada',
'ГАЗ',
],
'Germany' => [
'Mercedes Benz',
'Audi',
'BMW',
'Porsche',
'Opel',
]
];
$count = count($cars, COUNT_RECURSIVE);
print_r($count); // 9
Работа с ключами массива
Проверить существование ключа (индекса):
$array = [
'key_1' => 'Value 1',
'key_2' => 'Value 2',
'key_3' => 'Value 3',
];
if (array_key_exists('key_2', $array)) echo 'Ключ существует';
else echo 'Ключ не найден!';
Получить элемент массива по его ключу (индексу):
$array = ['Audi', 'BMW', 'Honda'];
// Получить первый элемент
$elem = $array[0];
print_r($elem); // Audi
Функция array_keys()
возвращает числовые и строковые ключи, содержащиеся в массиве:
$array = ['Audi', 'BMW', 'Honda'];
$keys = array_keys($array);
print_r($keys);
Результат:
Array
(
[0] => 0
[1] => 1
[2] => 2
)
Пример с ассоциативным массивом:
$cars = [
'Russian Federation' => [
'Lada',
'ГАЗ',
],
'Germany' => [
'Mercedes Benz',
'Audi',
'BMW',
'Porsche',
'Opel',
]
];
$keys = array_keys($cars);
print_r($keys);
Результат:
Array
(
[0] => Russian Federation
[1] => Germany
)
Функция array_key_first()
получает первый ключ массива:
$array = ['Audi', 'BMW', 'Honda'];
$elem = array_key_first($array);
print_r($elem); // 0
Функция array_key_last()
получает последний ключ массива:
$array = ['Audi', 'BMW', 'Honda'];
$elem = array_key_last($array);
print_r($elem); // 2
Функция array_search()
осуществляет поиск данного значения в массиве и возвращает ключ первого найденного элемента в случае успешного выполнения:
$array = ['Audi', 'BMW', 'Honda'];
$elem = array_search('BMW', $array);
print_r($elem); // 1
Получение элементов массива
Получить элемент массива по его ключу (индексу):
$array = ['Audi', 'BMW', 'Honda'];
// Получить первый элемент
$elem = $array[0];
print_r($elem); // Audi
Ассоциативный массив:
$cars = [
'Russian Federation' => [
'Lada',
'ГАЗ',
],
'Germany' => [
'Mercedes Benz',
'Audi',
'BMW',
'Porsche',
'Opel',
]
];
$elem = $cars['Germany'];
print_r($elem);
Результат:
Array
(
[0] => Mercedes Benz
[1] => Audi
[2] => BMW
[3] => Porsche
[4] => Opel
)
Получить первый элемент массива (функция current()
):
$array = ['Audi', 'BMW', 'Honda'];
$elem = current($array);
print_r($elem); // Audi
Получить последний элемент массива (функция end()
):
$array = ['Audi', 'BMW', 'Honda'];
$elem = end($array);
print_r($elem); // Honda
Получить часть (срез) массива. Функция array_slice($array, $offset, $length)
возвращает часть массива начиная с индекса $offset
длиной $length
. Если $offset
отрицательный, то отчет начинается с конца массива. $length
можно не указывать, тогда функция вернет все элементы до конца массива начиная с индекса $offset
:
$array = ['Audi', 'BMW', 'Honda'];
$elements = array_slice($array, 0, 2);
print_r($elements);
Результат:
Array
(
[0] => Audi
[1] => BMW
)
Функция array_shift()
извлекает первый элемент из массива и возвращает его значение.
$array = ['Audi', 'BMW', 'Honda'];
$first = array_shift($array);
print_r($first); // Audi
Все числовые ключи будут изменены таким образом, что нумерация массива начнётся с нуля, в то время как строковые ключи останутся прежними:
$array = ['Audi', 'BMW', 'Honda'];
$first = array_shift($array);
print_r($array);
Результат:
Array
(
[0] => BMW
[1] => Honda
)
Функция array_pop()
извлекает последний элемент из массива и возвращает его значение.
$array = ['Audi', 'BMW', 'Honda'];
$last = array_pop($array);
print_r($last); // Honda
Чтобы извлечь из массива часть, можно применить функции array_slice()
и array_diff()
.
$array = ['Audi', 'BMW', 'Honda'];
$slice = array_slice($array, 0, 2);
$diff = array_diff($array, $slice);
print_r($slice);
print_r($diff);
Результат:
Array
(
[0] => Audi
[1] => BMW
)
Array
(
[2] => Honda
)
Выбрать все значения из массива можно с помощью функции array_values()
. Создаётся новый массив из исходного массива, игнорируя его ключи:
$array = ['Audi', 'BMW', 'Honda'];
$values = array_values($array);
print_r($values);
Результат:
Array
(
[0] => Audi
[1] => BMW
[2] => Honda
)
Выбрать все ключи массива можно с помощью функции array_keys()
. Создаётся новый массив состоящий из ключей исходного массива:
$array = ['Audi', 'BMW', 'Honda'];
$keys = array_keys($array);
print_r($keys);
Результат:
Array
(
[0] => 0
[1] => 1
[2] => 2
)
Выбрать все случайные ключи из массива можно с помощью функции array_rand($array, $count)
. Если $count
больше единицы, то результат будет в виде массива:
$array = ['Audi', 'BMW', 'Honda'];
$rand = array_rand($array);
$rand_2 = array_rand($array, 2);
print_r($rand);
print_r($rand_2);
Поиск и проверка элементов в массиве
Проверить, есть ли значение в массиве:
$array = ['Audi', 'BMW', 'Honda'];
if (in_array('BMW', $array)) {
echo 'Найдено значение "BMW"';
}
// или
if (array_search('BMW', $array) !== false) {
echo 'Найдено значение "BMW"';
}
Проверить, есть ли ключ в массиве:
$array = ['Audi', 'BMW', 'Honda'];
if (array_key_exists(2, $array)) {
echo 'Найден ключ 2';
}
// или
if (isset($array[2])) {
echo 'Найден ключ 2';
}
Удаление элементов из массива
Функция unset()
удаляет переменные и элементы массива:
$array = ['Audi', 'BMW', 'Honda'];
// Удаление по ключу
unset($array[1]);
print_r($array);
Результат:
Array
(
[0] => Audi
[2] => Honda
)
Можно удалить элемент массива по значению:
$array = ['Audi', 'BMW', 'Honda'];
// Удаление по значению
unset($array[array_search('BMW', $array)]);
print_r($array);
Результат:
Array
(
[0] => Audi
[2] => Honda
)
Для удаления пустых значений в массиве в PHP нет отдельной функции, поэтому применяют функцию array_diff()
, которая возвращает расхождения массивов:
$array = ['Audi', '', 'Honda'];
$array = array_diff($array, ['']);
print_r($array);
Результат:
Array
(
[0] => Audi
[2] => Honda
)
Удалить повторяющиеся значения массива:
$array = ['Audi', 'BMW', 'Audi', 'Honda'];
$array = array_unique($array);
print_r($array);
Результат:
Array
(
[0] => Audi
[1] => BMW
[3] => Honda
)
Объединение массивов
$array_1 = ['Audi', 'BMW', 'Honda'];
$array_2 = ['Lexus', 'Nissan'];
$result = array_merge($array_1, $array_2);
print_r($result);
Результат:
Array
(
[0] => Audi
[1] => BMW
[2] => Honda
[3] => Lexus
[4] => Nissan
)
Разделить массив на части
Функция array_chunk($array, $size)
создает новый многомерный массив из исходного, деля его на равные части:
$array = ['Audi', 'BMW', 'Honda', 'Lexus', 'Nissan', 'Mazda', 'Opel', 'Subaru'];
$result = array_chunk($array, 3);
print_r($result);
Результат:
Array
(
[0] => Array
(
[0] => Audi
[1] => BMW
[2] => Honda
)
[1] => Array
(
[0] => Lexus
[1] => Nissan
[2] => Mazda
)
[2] => Array
(
[0] => Opel
[1] => Subaru
)
)
Если требуется разделить массив на определенное количество частей можно воспользоваться следующим приемом:
$array = ['Audi', 'BMW', 'Honda', 'Lexus', 'Nissan', 'Mazda', 'Opel', 'Subaru'];
$result = array_chunk($array, ceil(count($array) / 2));
print_r($result);
Результат:
Array
(
[0] => Array
(
[0] => Audi
[1] => BMW
[2] => Honda
[3] => Lexus
)
[1] => Array
(
[0] => Nissan
[1] => Mazda
[2] => Opel
[3] => Subaru
)
)
Группировка массивов по ключу
Дано: Есть многомерный массив из товаров с типами цен:
$array = [
0 => [
'supplierId' => '1490000210',
'vat_mrc' => 20839.2,
],
1 => [
'supplierId' => '1490000210',
'tarif' => 18280,
],
2 => [
'supplierId' => '1490000210',
'vat_tarif' => 21936,
],
3 => [
'supplierId' => '1079000450',
'vat_mrc' => 19328.06,
],
4 => [
'supplierId' => '1079000450',
'tarif' => 21765.83,
],
5 => [
'supplierId' => '1079000450',
'mrc' => 10300.30,
],
];
Задача: Сгруппировать товары по коду поставщика. То есть, из пяти представленных массивов должно получиться два со всеми типами цен:
$result = [];
foreach ($array as $item):
foreach ($item as $key => $value):
$result[$item['supplierId']][$key] = $value;
endforeach;
endforeach;
Результат:
Array
(
[1490000210] => Array
(
[supplierId] => 1490000210
[vat_mrc] => 20839.2
[tarif] => 18280
[vat_tarif] => 21936
)
[1079000450] => Array
(
[supplierId] => 1079000450
[vat_mrc] => 19328.06
[tarif] => 21765.83
[mrc] => 10300.3
)
)