array_filter

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

array_filterFiltra gli elementi di un array usando una funzione callback

Descrizione

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

Itera su ogni valore dell'array passandolo alla funzione callback. Se la funzione callback restituisce true, il valore corrente dell'array viene restituito nell'array risultante.

Le chiavi dell'array sono preservate e possono risultare in lacune se l'array era indicizzato. L'array risultante può essere reindicizzato usando la funzione array_values().

Elenco dei parametri

array

L'array su cui iterare

callback

La funzione callback da utilizzare

Se non viene fornito alcun callback, tutti gli elementi vuoti dell'array verranno rimossi. Vedere empty() per come PHP definisce vuoto in questo caso.

mode

Flag che determina quali argomenti vengono inviati al callback:

  • ARRAY_FILTER_USE_KEY - passa la chiave come unico argomento al callback invece del valore
  • ARRAY_FILTER_USE_BOTH - passa sia il valore che la chiave come argomenti al callback invece del solo valore
Il valore predefinito è 0 che passa il valore come unico argomento al callback.

Valori restituiti

Restituisce l'array filtrato.

Log delle modifiche

Versione Descrizione
8.0.0 callback è ora nullable.
8.0.0 If callback expects a parameter to be passed by reference, this function will now emit an E_WARNING.

Esempi

Example #1 Esempio di array_filter()

<?php
function odd($var)
{
// restituisce se l'intero di input è dispari
return $var & 1;
}

function
even($var)
{
// restituisce se l'intero di input è pari
return !($var & 1);
}

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

echo
"Dispari :\n";
print_r(array_filter($array1, "odd"));
echo
"Pari:\n";
print_r(array_filter($array2, "even"));
?>

Il precedente esempio visualizzerà:

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

Example #2 array_filter() senza callback

<?php

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

print_r(array_filter($entry));
?>

Il precedente esempio visualizzerà:

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

Example #3 array_filter() con 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));
?>

Il precedente esempio visualizzerà:

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

Note

Attenzione

Se l'array viene modificato dalla funzione callback (ad esempio aggiungendo o rimuovendo un elemento) il comportamento di questa funzione non è definito.

Vedere anche:

  • array_intersect() - Calcola l'intersezione degli arrays
  • array_find() - Returns the first element satisfying a callback function
  • array_any() - Checks if at least one array element satisfies a callback function
  • array_map() - Applica la funzione callback a tutti gli elementi degli array dati
  • array_reduce() - Riduce iterativamente l'array a un singolo valore utilizzando una funzione callback

add a note

User Contributed Notes 7 notes

up
54
nicolaj dot knudsen at gmail dot com
8 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
35
Niko E
3 years ago
Note that a filtered array no longer encodes to json arrays, as the indices are no longer continuous:

$a = ['a', 'b', 'c'];
var_dump(json_encode($a)); //  ["a","b","c"]
$a = array_filter($a, function ($x) { return $x == 'b'; });
var_dump(json_encode($a)); // {"1": "b"}

you can use array_values get a continuous array

var_dump(json_encode(array_values($a))); // ["b"]
up
22
Merlindog
2 years ago
It is clearly documented above, but make sure you never forget that when ARRAY_FILTER_USE_BOTH is set, the callback argument order is value, key - NOT key, value. You'll save some time.
up
35
marc dot vanwoerkom at fernuni-hagen dot de
21 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
18
TechNyquist
3 years ago
Keep in mind that, as of PHP 7.4 and above, you can use arrow functions to as argument.
So for example if you want to leave values bigger than 10:

<?php
    $arr = array_filter($numbers, fn($n) => $n > 10);
?>

also, combine with key-flag to cut certain keys:

<?php
    $arr = array_filter($entries, fn($key) => !in_array($key, ['key1', 'key5']), ARRAY_FILTER_USE_KEY);
?>

and so on.
up
11
marc dot gray at gmail dot com
11 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.
up
2
Hayley Watson
2 years ago
The fact that array_filter preserves keys makes partitioning an array into [elements that pass the test, elements that fail the test] quite easy. In essence:

<?php
function partition($array, $test)
{
    $pass = array_filter($array, $test);
    $fail = array_diff_key($array, $pass);
    return [false => $fail, true => $pass];
}
?>

The array_diff_key call is key; indexing the returned array as shown allows lines like "$failures = $partition[false];" to do the right thing (the booleans get converted to integers of course, but it's consistent and self-documenting).
To Top