array_filter

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

array_filterФильтрует элементы массива с помощью callback-функции

Описание

array_filter(array $array, ?callable $callback = null, int $mode = 0): array

Обходит каждое значение массива array, передавая его в callback-функцию. Если callback-функция возвращает true, данное значение из array возвращается в результирующий array.

Ключи массива сохраняются и могут привести к пропускам, если array был проиндексирован. Результат массива (array) можно переиндексировать с помощью функции array_values().

Список параметров

array

Итерируемый массив

callback

Используемая callback-функция

Если callback-функция не передана, все пустые значения массива array будут удалены. Смотрите empty(), чтобы узнать, как PHP определяет пустое значение в этом случае.

mode

Флаг, определяющий, какие аргументы передавать в callback:

  • ARRAY_FILTER_USE_KEY - передавать только ключ массива как аргумент для callback вместо значения
  • ARRAY_FILTER_USE_BOTH - передавать и ключ, и значение в callback вместо только значения
По умолчанию 0, что означает, что в callback-функцию будет передаваться только значение в качестве единственного аргумента.

Возвращаемые значения

Возвращает отфильтрованный массив.

Список изменений

Версия Описание
8.0.0 callback теперь допускает значение null.
8.0.0 Если параметр callback ожидает, что будет передано значение по ссылке, функция теперь выдаст ошибку уровня E_WARNING.

Примеры

Пример #1 Пример использования array_filter()

<?php
function odd($var)
{
// является ли переданное число нечётным
return $var & 1;
}

function
even($var)
{
// является ли переданное число чётным
return !($var & 1);
}

$array1 = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5];
$array2 = [6, 7, 8, 9, 10, 11, 12];

echo
"Нечётные:\n";
print_r(array_filter($array1, "odd"));
echo
"Чётные:\n";
print_r(array_filter($array2, "even"));
?>

Результат выполнения данного примера:

Нечётные:
Array
(
    [a] => 1
    [c] => 3
    [e] => 5
)
Чётные:
Array
(
    [0] => 6
    [2] => 8
    [4] => 10
    [6] => 12
)

Пример #2 Использование array_filter() без callback-функции

<?php

$entry
= [
0 => 'foo',
1 => false,
2 => -1,
3 => null,
4 => '',
5 => '0',
6 => 0,
];

print_r(array_filter($entry));
?>

Результат выполнения данного примера:

Array
(
    [0] => foo
    [2] => -1
)

Пример #3 array_filter() с указанным mode

<?php

$arr
= ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4];

var_dump(array_filter($arr, function($k) {
return
$k == 'b';
},
ARRAY_FILTER_USE_KEY));

var_dump(array_filter($arr, function($v, $k) {
return
$k == 'b' || $v == 4;
},
ARRAY_FILTER_USE_BOTH));
?>

Результат выполнения данного примера:

array(1) {
  ["b"]=>
  int(2)
}
array(2) {
  ["b"]=>
  int(2)
  ["d"]=>
  int(4)
}

Примечания

Предостережение

Если callback-функция изменяет массив (например, добавляет или удаляет элементы), поведение этой функции неопределённо.

Смотрите также

  • array_intersect() - Вычисляет схождение массивов
  • array_map() - Применяет callback-функцию ко всем элементам указанных массивов
  • array_reduce() - Итеративно уменьшает массив к единственному значению, используя callback-функцию
  • array_walk() - Применяет заданную пользователем функцию к каждому элементу массива