array_filter

(PHP 4 >= 4.0.6, PHP 5)

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

Описание

array array_filter ( array $input [, callable $callback = "" ] )

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

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

input

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

callback

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

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

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

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

Примеры

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

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

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

$array1 = array("a"=>1"b"=>2"c"=>3"d"=>4"e"=>5);
$array2 = array(6789101112);

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 
= array(
             
=> 'foo',
             
=> false,
             
=> -1,
             
=> null,
             
=> ''
          
);

print_r(array_filter($entry));
?>

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

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

Примечания

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

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

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

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

Коментарии

I was looking for a function to delete values from an array and thought I had found it in array_filter(), however, I *didn't* want the keys to be preserved *and* I needed blank values cleaned out of the array as well. I came up with the following (with help from many of the above examples):

<?php
function array_delete($array$filterfor){
 
$thisarray = array ();
  foreach(
$array as $value)
    if(
stristr($value$filterfor)===false && strlen($value)>0)
     
$thisarray[] = $value;
  return 
$thisarray;
}

$array1 = array ('OtHeR','this''that''Other',''9101'fifty''other','','');

echo 
"<pre>array :\n";
print_r($array1);

$array2=array_delete($array1"Other");

echo 
"filtered:\n";
print_r($array2);
?>
2002-08-17 16:04:04
http://php5.kiev.ua/manual/ru/function.array-filter.html
be careful with the above function "array_delete"'s use of the stristr function, it could be slightly misleading. consider the following:

<?php
function array_delete($array$filterforsubstring){
   
$thisarray = array ();
    foreach(
$array as $value)
        if(
stristr($value$filterforsubstring)===false && strlen($value)>0)
           
$thisarray[] = $value;
    return 
$thisarray;
}

function 
array_delete2($array$filterforstring$removeblanksflag=0){
   
$thisarray = array ();
    foreach(
$array as $value)
        if(!(
stristr($value$filterforstring) && strlen($value)==strlen($filterforstring))
                && !(
strlen($value)==&& $removeblanksflag))
           
$thisarray[] = $value;
    return 
$thisarray;
}

function 
array_delete3($array$filterfor$substringflag=0$removeblanksflag=0){
   
$thisarray = array ();
    foreach(
$array as $value)
        if(
            !(
stristr($value$filterfor
                && (
$substringflag || strlen($value)==strlen($filterfor))
            )
            && !(
strlen($value)==&& $removeblanksflag)
        )
           
$thisarray[] = $value;
    return 
$thisarray;
}

$array1 = array ('the OtHeR thang','this''that''OtHer',''9101'fifty'' oTher''otHer ','','other','Other','','other blank things');

echo 
"<pre>array :\n";
print_r($array1);

$array2=array_delete($array1"Other");

echo 
"array_delete(\$array1, \"Other\"):\n";
print_r($array2);

$array2=array_delete2($array1"Other");

echo 
"array_delete2(\$array1, \"Other\"):\n";
print_r($array2);

$array2=array_delete2($array1"Other",1);

echo 
"array_delete2(\$array1, \"Other\",1):\n";
print_r($array2);

$array2=array_delete3($array1"Other",1);

echo 
"array_delete3(\$array1, \"Other\",1):\n";
print_r($array2);

$array2=array_delete3($array1"Other",0,1);

echo 
"array_delete3(\$array1, \"Other\",0,1):\n";
print_r($array2);
 
?>
2002-09-27 15:42:51
http://php5.kiev.ua/manual/ru/function.array-filter.html
Автор:
For any type of array. Basead in redshift code.

<?php
function array_clean ($array$todelete false$caseSensitive false) {
    foreach(
$array as $key => $value) {
        if(
is_array($value)) {
           
$array[$key] = array_clean($array[$key], $todelete$caseSensitive);
        }
        else {
            if(
$todelete) {
                if(
$caseSensitive) {
                    if(
strstr($value ,$todelete) !== false)
                        unset(
$array[$key]);
                }
                else {
                    if(
stristr($value$todelete) !== false)
                        unset(
$array[$key]);
                }
            }
            elseif (empty(
$value)) {
                unset(
$array[$key]);
            }
        }
    }
    return 
$array;
}
?>
2004-05-11 11:17:27
http://php5.kiev.ua/manual/ru/function.array-filter.html
Some of PHP's array functions play a prominent role in so called functional programming languages, where they show up under a slightly different name:

<?php
  array_filter
() -> filter(), 
 
array_map() -> map(), 
 
array_reduce() -> foldl() ("fold left")
?>

Functional programming is a paradigm which centers around the side-effect free evaluation of functions. A program execution is a call of a function, which in turn might be defined by many other functions. One idea is to use functions to create special purpose functions from other functions.

The array functions mentioned above allow you compose new functions on arrays. 

E.g. array_sum = array_map("sum", $arr).

This leads to a style of programming that looks much like algebra, e.g. the Bird/Meertens formalism.

E.g. a mathematician might state

  map(f o g) = map(f) o map(g)

the so called "loop fusion" law.

Many functions on arrays can be created by the use of the foldr() function (which works like foldl, but eating up array elements from the right).

I can't get into detail here, I just wanted to provide a hint about where this stuff also shows up and the theory behind it.
2004-07-05 11:09:16
http://php5.kiev.ua/manual/ru/function.array-filter.html
Автор:
This function trims empty strings from the beginning and end of an array.
It's useful when outputing plaintext files on a page and you want to skip empty lines at the beginning and end, but not within the text.

<?php
function array_trim($array) {
    while (
strlen(reset($array)) === 0) {
       
array_shift($array);
    }
    while (
strlen(end($array)) === 0) {
       
array_pop($array);
    }
    return 
$array;
}
?>

You might want to trim each element too.
2007-09-04 13:56:47
http://php5.kiev.ua/manual/ru/function.array-filter.html
Regarding comment about trimming empty strings, the code posted will get into an infinite loop if the array is reduced to zero elements. The following might be better:

<?php
function array_trim($array) {
    while (!empty(
$array) and strlen(reset($array)) === 0) {
       
array_shift($array);
    }
    while (!empty(
$array) and strlen(end($array)) === 0) {
       
array_pop($array);
    }
    return 
$array;
}
?>
2008-10-08 14:44:06
http://php5.kiev.ua/manual/ru/function.array-filter.html
This function filters an array and remove all null values recursively.

<?php
 
function array_filter_recursive($input)
  {
    foreach (
$input as &$value)
    {
      if (
is_array($value))
      {
       
$value array_filter_recursive($value);
      }
    }
   
    return 
array_filter($input);
  }
?>

Or with callback parameter (not tested) :

<?php
 
function array_filter_recursive($input$callback null)
  {
    foreach (
$input as &$value)
    {
      if (
is_array($value))
      {
       
$value array_filter_recursive($value$callback);
      }
    }
   
    return 
array_filter($input$callback);
  }
?>
2008-12-11 08:39:13
http://php5.kiev.ua/manual/ru/function.array-filter.html
Автор:
In case you are interested (like me) in filtering out elements with certain key-names, array_filter won't help you. Instead you can use the following:

<?php
$arr 
= array( 'element1' => 1'element2' => 2'element3' => 3'element4' => );
$filterOutKeys = array( 'element1''element4' );

$filteredArr array_diff_key$arrarray_flip$filterOutKeys ) )
?>

Result will be something like this:
['element2'] => 2
['element3'] => 3
2008-12-30 03:27:57
http://php5.kiev.ua/manual/ru/function.array-filter.html
I use the following to see if a array consist of scalar values or null, but of course you could mix it up using any of the is_ functions.

<?php
if(count($data) !== count(array_filter($data'is_scalar') + array_filter($data'is_null'))) {
  throw new 
Exception('Array did not consist of scalar and null values');
}
?>
2009-04-30 12:34:06
http://php5.kiev.ua/manual/ru/function.array-filter.html
Here's a function that will filter a multi-demensional array. This filter will return only those items that match the $value given

<?php
   
/*
     * filtering an array
     */
   
function filter_by_value ($array$index$value){ 
        if(
is_array($array) && count($array)>0
        { 
            foreach(
array_keys($array) as $key){
               
$temp[$key] = $array[$key][$index];
                 
                if (
$temp[$key] == $value){
                   
$newarray[$key] = $array[$key];
                }
            }
          }
      return 
$newarray
    } 
?>

Example:

<?php
$results 
= array(
   
=> array('key1' => '1''key2' => 2'key3' => 3),
   
=> array('key1' => '12''key2' => 22'key3' => 32
);

$nResults filter_by_value($results'key2''2');
?>

Output :

array(
    0 => array('key1' => '1', 'key2' => 2, 'key3' => 3)
);
2009-10-08 16:00:24
http://php5.kiev.ua/manual/ru/function.array-filter.html
Автор:
Because array_filter() preserves keys, you should consider the resulting array to be an associative array even if the original array had integer keys for there may be holes in your sequence of keys. This means that, for example, json_encode() will convert your result array into an object instead of an array. Call array_values() on the result array to guarantee json_encode() gives you an array.
2010-08-12 11:09:07
http://php5.kiev.ua/manual/ru/function.array-filter.html
You can access the current key of array by passing a reference to array into callback function and call key() and next() method in the callback function:
<?php
$data 
= array('first' => 1'second' => 2'third' => 3);
$data array_filter($data, function ($item) use (&$data) {
    echo 
"Filtering key "key($data), '<br>'PHP_EOL;
   
next($data);
    return 
false;
});
?>

However be careful with array internal pointer or use reset() method before calling array_filter().
2011-07-22 03:54:50
http://php5.kiev.ua/manual/ru/function.array-filter.html
<?php
// ARRAY FILTER RECURSIVE USING CLASS, STATIC METHOD, AND ANONYMOUS CALLBACK FUNCTION
// NOTE THAT THE CALLBACK HAS ACCESS TO BOTH THE KEY AND VALUE

// THE CLASS (FOR YOU TO COPY)
class ArrayUtil
{
    public static function 
FilterRecursive(Array $source$fn)
    {
       
$result = array();
        foreach (
$source as $key => $value)
        {
            if (
is_array($value))
            {
               
$result[$key] = self::FilterRecursive($value$fn);
                continue;
            }
            if (
$fn($key$value))
            {
               
$result[$key] = $value// KEEP
               
continue;
            }
        }
        return 
$result;
    }
}

// EXAMPLE ANONYMOUS CALLBACK FUNCTION
$fn = function ($key$value)
{
    if (
strpos($key'drop') !== FALSE)
    {
        return 
FALSE// DROP
   
}
    return 
TRUE// KEEP
};

// EXAMPLE PRE FILTER TEST DATA
$preFilter = array(
   
'a' => 'one',
   
'b' => array(
       
'example_drop' => 'filter me out',
       
'example_keep' => 'keep me',
    ),
   
'c' => 'three',
);

// EXAMPLE USAGE CODE
echo '// print_r($preFilter);' "\n";
print_r($preFilter);
$postFilter ArrayUtil::FilterRecursive($preFilter$fn);
echo 
"\n";
echo 
'// print_r($postFilter);' "\n";
print_r($postFilter);

/* OUTPUT OPEN
// print_r($preFilter);
Array
(
    [a] => one
    [b] => Array
        (
            [example_drop] => filter me out
            [example_keep] => keep me
        )

    [c] => three
)

// print_r($postFilter);
Array
(
    [a] => one
    [b] => Array
        (
            [example_keep] => keep me
        )

    [c] => three
)
OUTPUT CLOSE */
2012-04-04 23:09:41
http://php5.kiev.ua/manual/ru/function.array-filter.html
You can use array_filter from within a class to access a protected method from that same class:

<?php

class Bar {
    public function 
foo()
    {
       
$array1 = array("a"=>1"b"=>2"c"=>3"d"=>4"e"=>5);

       
print_r(array_filter($array1, array($this'naz')));
    }

    protected function 
baz($var)
    {
        return(
$var 1);
    }
}

$bar = new Bar();
$bar->foo();
?>
2012-10-04 22:11:23
http://php5.kiev.ua/manual/ru/function.array-filter.html
Автор:
If you want a quick way to remove NULL, FALSE and Empty Strings (""), but leave values of 0 (zero), you can use the standard php function strlen as the callback function:
eg:
<?php

// removes all NULL, FALSE and Empty Strings but leaves 0 (zero) values
$result array_filter$array'strlen' );

?>
2013-01-13 19:52:07
http://php5.kiev.ua/manual/ru/function.array-filter.html
<?php
function array_filter_recursive ($data) {
   
$original $data;

   
$data array_filter($data);
   
   
$data array_map(function ($e) {
        return 
is_array($e) ? array_filter_recursive($e) : $e;
    }, 
$data);

    return 
$original === $data $data array_filter_recursive($data);
}

$data = ['a' => 0'b' => [], 'c' => [[]], 'd' => [[[[]]]], 'e' => 'foo''f' => [[['a']]], [true], [[],['a'], [truefalse]]];

$data array_filter_recursive($data);
?>
2013-03-26 13:10:55
http://php5.kiev.ua/manual/ru/function.array-filter.html
Автор:
nice trick:

$array_out = array_filter($array_in, function($var) use($array_other) {
            return in_array($var, $array_other) ? true : false;
});
2013-11-04 02:25:45
http://php5.kiev.ua/manual/ru/function.array-filter.html
My favourite use of this function is converting a string to an array, trimming each line and removing empty lines:

<?php
$array 
array_filter(array_map('trim'explode("\n"$string)), 'strlen');
?>

Although it states clearly that array keys are preserved, it's important to note this includes numerically indexed arrays. You can't use a for loop on $array above without processing it through array_values() first.
2014-04-29 13:44:43
http://php5.kiev.ua/manual/ru/function.array-filter.html
array_filter remove also FALSE and 0. To remove only NULL's use:

$af = [1, 0, 2, null, 3, 6, 7];

function is_not_null($val){
    return !is_null($val);
}
$af = array_filter($af, 'is_not_null');
2014-09-21 15:33:18
http://php5.kiev.ua/manual/ru/function.array-filter.html
If you want to pass the key to the callback function before PHP 5.6.0 (when the flag parameter wasn't implemented):

<?php

$result 
array_filter(array_keys($array), 'is_int');

?>
2015-01-09 10:56:03
http://php5.kiev.ua/manual/ru/function.array-filter.html
If you have an array of KV pairs and you want all the items where a value is X, you dont need to make a callback for array_filter. You can use array_intersect:

<?php
print_r
(array_intersect(
  array(
   
'a' => 1,
   
'b' => 1,
   
'c' => 1,
   
'd' => 2,
   
'e' => 2,
   
'f' => 2,
  ),
  array(
1)
));

Array
(
    [
a] => 1
   
[b] => 1
   
[c] => 1
)
?>

The advantage of this approach is you can pass variables into the second array without needing to worry about variable scope and function parameters for array_filter.
2015-04-30 16:18:25
http://php5.kiev.ua/manual/ru/function.array-filter.html
If you like me have some trouble understanding example #1 due to the bitwise operator (&) used, here is an explanation.

The part in question is this callback function:

<?php
function odd($var)
{
   
// returns whether the input integer is odd
   
return($var 1);
}
?>

If given an integer this function returns the integer 1 if $var is odd and the integer 0 if $var is even.
The single ampersand, &, is the bitwise AND operator. The way it works is that it takes the binary representation of the two arguments and compare them bit for bit using AND. If $var = 45, then since 45 in binary is 101101 the operation looks like this:

45 in binary: 101101
1 in binary:  000001
              ------
result:       000001

Only if the last bit in the binary representation of $var is changed to zero (meaning that the value is even) will the result change to 000000, which is the representation of zero.
2017-04-05 15:05:22
http://php5.kiev.ua/manual/ru/function.array-filter.html
/**
   * Remove key from multidimensional array
   *
   * @param array $request
   * @param array $keys
   *
   * @return array
   */
function request_filter(array $request, array $keys) {
    array_walk($request, function (&$value, $key) use ($keys) {
        if(is_array($value)) {
            $value = request_filter($value, $keys);
        }
    });

    return array_filter ($request, function ($value, $key) use ($keys) {
        return ! in_array($key, $keys);
    }, ARRAY_FILTER_USE_BOTH);
}

$data = [
  'a' => 'A',
  'password' => 123,
  'data' => [
      'b' => 'B',
      'data2' => [
           'c' => 'C',
            'password' => 545,
    ],
    'password' => 321,
  ]
];

print_r(request_filter($data, ['password']));

Output will be:
Array
(
    [a] => A
    [data] => Array
        (
            [b] => B
            [data2] => Array
                (
                    [c] => C
                )

        )

)
2020-09-22 20:43:33
http://php5.kiev.ua/manual/ru/function.array-filter.html

    Поддержать сайт на родительском проекте КГБ