array_filter

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

array_filterFiltruje elementy przy użyciu callbacku

Opis

array_filter ( array $tablica [, callable $callback [, int $flaga = 0 ]] ) : array

Iteruje przez każdą wartość w tablicy przekazując ją do funkcji podanej jako callback. Jeżeli callback zwraca TRUE, obecna wartość z podanej tablicy jest zwracana w tablicy wynikowej. Klucze tablic są zachowywane.

Parametry

tablica

Tablica do przefiltrowania

callback

Funkcja zwrotna do użycia

Jeżeli nie został podany callback, to wszystkie wpisy tablicy odpowiadające FALSE (zobacz: konwersja do wartości logicznych) zostaną usunięte.

flaga

Flaga określająca jakie parametry są wysyłane do callbacku:

  • ARRAY_FILTER_USE_KEY - przekaż klucz jako jedyny argument do callbacku, zamiast wartości
  • ARRAY_FILTER_USE_BOTH - przekaż zarówno wartość i klucz jako argumenty do callbacku, zamiast wartości

Zwracane wartości

Zwraca przefiltrowaną tablicę.

Rejestr zmian

Wersja Opis
5.6.0 Dodano opcjonalny parametr flagi oraz stałe ARRAY_FILTER_USE_KEY i ARRAY_FILTER_USE_BOTH

Przykłady

Przykład #1 Przykład użycia array_filter()

<?php
function nieparzysta($var)
{
    
// sprawdza czy podana liczba jest nieparzysta
    
return($var 1);
}

function 
parzysta($var)
{
    
// sprawdza czy podana liczba jest parzysta
    
return(!($var 1));
}

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

echo 
"Nieparzyste:\n";
print_r(array_filter($array1"nieparzysta"));
echo 
"Parzyste:\n";
print_r(array_filter($array2"parzysta"));
?>

Powyższy przykład wyświetli:

Nieparzyste:
Array
(
    [a] => 1
    [c] => 3
    [e] => 5
)
Parzyste:
Array
(
    [0] => 6
    [2] => 8
    [4] => 10
    [6] => 12
)

Przykład #2 array_filter() bez parametru callback

<?php

$entry 
= array(
             
=> 'foo',
             
=> false,
             
=> -1,
             
=> null,
             
=> ''
          
);

print_r(array_filter($entry));
?>

Powyższy przykład wyświetli:

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

Przykład #3 array_filter() z flagą

<?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));
?>

Powyższy przykład wyświetli:

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

Notatki

Uwaga

Jeżeli funkcja zwrotna zmienia tablicę (np. dodaje lub usuwa element), to rezultaty działania tej funkcji mogą nie być zgodne z oczekiwaniami.

Zobacz też:

  • array_map() - Stosuje podany callback do elementów podanych tablic
  • array_reduce() - Iteracyjnie zredukuj tablicę do pojedyńczej wartości używając funkcji zwrotnej
  • array_walk() - Zastosuj funkcję użytkownika do każdego elementu tablicy

add a note add a note

User Contributed Notes 4 notes

up
528
Anonymous
11 years ago
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' );

?>
up
17
nicolaj dot knudsen at gmail dot com
6 years ago
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.
up
28
marc dot vanwoerkom at fernuni-hagen dot de
19 years ago
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.
up
9
marc dot gray at gmail dot com
9 years ago
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.
To Top