array_filter
Iterates over each value in the array passing them to the callback function. If the callback function returns true , the current value from array is returned into the result array .
Array keys are preserved, and may result in gaps if the array was indexed. The result array can be reindexed using the array_values() function.
Parameters
The array to iterate over
The callback function to use
If no callback is supplied, all empty entries of array will be removed. See empty() for how PHP defines empty in this case.
- ARRAY_FILTER_USE_KEY — pass key as the only argument to callback instead of the value
- ARRAY_FILTER_USE_BOTH — pass both value and key as arguments to callback instead of the value
Return Values
Returns the filtered array.
Changelog
Version | Description |
---|---|
8.0.0 | callback is nullable now. |
8.0.0 | If callback expects a parameter to be passed by reference, this function will now emit an E_WARNING . |
Examples
Example #1 array_filter() example
function odd ( $var )
// returns whether the input integer is odd
return $var & 1 ;
>
?php
function even ( $var )
// returns whether the input integer is even
return !( $var & 1 );
>
$array1 = [ ‘a’ => 1 , ‘b’ => 2 , ‘c’ => 3 , ‘d’ => 4 , ‘e’ => 5 ];
$array2 = [ 6 , 7 , 8 , 9 , 10 , 11 , 12 ];
echo «Odd :\n» ;
print_r ( array_filter ( $array1 , «odd» ));
echo «Even:\n» ;
print_r ( array_filter ( $array2 , «even» ));
?>
The above example will output:
Odd : Array ( [a] => 1 [c] => 3 [e] => 5 ) Even: Array ( [0] => 6 [2] => 8 [4] => 10 [6] => 12 )
Example #2 array_filter() without callback
$entry = [
0 => ‘foo’ ,
1 => false ,
2 => — 1 ,
3 => null ,
4 => » ,
5 => ‘0’ ,
6 => 0 ,
];
print_r ( array_filter ( $entry ));
?>
The above example will output:
Example #3 array_filter() with mode
$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 ));
?>
The above example will output:
array(1) < ["b"]=>int(2) > array(2) < ["b"]=>int(2) ["d"]=> int(4) >
Notes
If the array is changed from the callback function (e.g. element added, deleted or unset) the behavior of this function is undefined.
See Also
- array_intersect() — Computes the intersection of arrays
- array_map() — Applies the callback to the elements of the given arrays
- array_reduce() — Iteratively reduce the array to a single value using a callback function
- array_walk() — Apply a user supplied function to every member of an array
User Contributed Notes 9 notes
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:
// removes all NULL, FALSE and Empty Strings but leaves 0 (zero) values
$result = array_filter ( $array , ‘strlen’ );
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)); //
you can use array_values get a continuous array
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:
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.
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:
$arr = array_filter ( $numbers , fn ( $n ) => $n > 10 );
?>
also, combine with key-flag to cut certain keys:
$arr = array_filter ( $entries , fn ( $key ) => ! in_array ( $key , [ ‘key1’ , ‘key5’ ]), ARRAY_FILTER_USE_KEY );
?>
and so on.
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:
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
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.
Depending on the intended meanings of your «empty» array values, e.g., null and empty string, vs. an integer 0 or a boolean false, be mindful of the result of different filters.
$array = array( ‘null’ => null , ‘nullstring’ => » , ‘intzero’ => 0 , ‘stringzero’ => ‘0’ , ‘false’ => false , ‘stringfalse’ => ‘false’ , );
// Removes null, null-string — but also FALSE!
$filtered1 = array_filter ( $array , ‘strlen’ );
// Removes only null.
$filtered2 = array_filter ( $array , function( $v ) < return ! is_null ( $v ); >);
// Removes null and null-string. Keeps FALSE and 0.
$filtered3 = array_filter ( $array , function( $v ) < return !( is_null ( $v ) or '' === $v ); >);
var_dump ( $array , $filtered1 , $filtered2 , $filtered3 );
?>
Results in:
array (size=3)
‘intzero’ => int 0
‘stringzero’ => string ‘0’ (length=1)
‘stringfalse’ => string ‘false’ (length=5)
array (size=5)
‘nullstring’ => string » (length=0)
‘intzero’ => int 0
‘stringzero’ => string ‘0’ (length=1)
‘false’ => boolean false
‘stringfalse’ => string ‘false’ (length=5)
array (size=4)
‘intzero’ => int 0
‘stringzero’ => string ‘0’ (length=1)
‘false’ => boolean false
‘stringfalse’ => string ‘false’ (length=5)
My favourite use of this function is converting a string to an array, trimming each line and removing empty lines:
$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.
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.
Check if all elements in array are not empty/null/falsy.
——————————
Supposing you have a one dimensional array.
$spicy_numbers = [ 69 , 420 , ɸ ];
?>
And you want to easily check that all elements in said array are not null/empty/any falsy value, instead of running a loop over each element, you can pass the array to , with no callback function, and then check if the returned array is the same size as the original, since strips out all non-truthy values including 0 when no callback is provided.
Example:
$spicy_numbers = [ 69 , 420 , » ]; // Phi is gone!
if ( count ( array_filter ( $spicy_numbers ) ) !== count ( $spicy_numbers ) ) // One of the elements is empty/null/falsy.
> else // All elements present and truthy.
>
?>
As a neat little function, you could do this:
/**
* Checks if all of given array’s elements have a non-falsy value.
* Use-case: If all items in array are set and have a value (truthy, of course), then do X; else, do Y.
*
* @param array $arr
* @return bool
*/
function is_array_full ( $arr ) $array_count = count ( $arr );
$filtered_count = count ( array_filter ( $arr ) );
return ( $array_count === $filtered_count ) ? true : false ;
>
?>
- Array Functions
- array_change_key_case
- array_chunk
- array_column
- array_combine
- array_count_values
- array_diff_assoc
- array_diff_key
- array_diff_uassoc
- array_diff_ukey
- array_diff
- array_fill_keys
- array_fill
- array_filter
- array_flip
- array_intersect_assoc
- array_intersect_key
- array_intersect_uassoc
- array_intersect_ukey
- array_intersect
- array_is_list
- array_key_exists
- array_key_first
- array_key_last
- array_keys
- array_map
- array_merge_recursive
- array_merge
- array_multisort
- array_pad
- array_pop
- array_product
- array_push
- array_rand
- array_reduce
- array_replace_recursive
- array_replace
- array_reverse
- array_search
- array_shift
- array_slice
- array_splice
- array_sum
- array_udiff_assoc
- array_udiff_uassoc
- array_udiff
- array_uintersect_assoc
- array_uintersect_uassoc
- array_uintersect
- array_unique
- array_unshift
- array_values
- array_walk_recursive
- array_walk
- array
- arsort
- asort
- compact
- count
- current
- end
- extract
- in_array
- key_exists
- key
- krsort
- ksort
- list
- natcasesort
- natsort
- next
- pos
- prev
- range
- reset
- rsort
- shuffle
- sizeof
- sort
- uasort
- uksort
- usort
- each
Функции фильтрации данных
I recommend you to use the FILTER_REQUIRE_SCALAR (or FILTER_REQUIRE_ARRAY) flags, since you can use array-brackets both to access string offsets and array-element — however, not only this can lead to unexpected behaviour. Look at this example:
$image = basename ( filter_input ( INPUT_GET , ‘src’ , FILTER_UNSAFE_RAW , FILTER_FLAG_STRIP_LOW ));
// further checks
?>/script.php?src[0]=foobar will cause a warning. 🙁
Hence my recommendation:$image = basename ( filter_input ( INPUT_GET , ‘src’ , FILTER_UNSAFE_RAW , FILTER_REQUIRE_SCALAR | FILTER_FLAG_STRIP_LOW ));
// further checks
?>Also notice that filter functions are using only the original variable values passed to the script even if you change the value in super global variable ($_GET, $_POST, . ) later in the script.
echo filter_input ( INPUT_GET , ‘var’ ); // print ‘something’
echo $_GET [ ‘var’ ]; // print ‘something’
$_GET [ ‘var’ ] = ‘changed’ ;
echo filter_input ( INPUT_GET , ‘var’ ); // print ‘something’
echo $_GET [ ‘var’ ]; // print ‘changed’
?>In fact, external data are duplicated in SAPI before the script is processed and filter functions don’t use super globals anymore (as explained in Filter tutorial bellow, section ‘How does it work?’).
There is an undocumented filter flag for FILTER_VALIDATE_BOOLEAN. The documentation implies that it will return NULL if the value doesn’t match the allowed true/false values. However this doesn’t happen unless you give it the FILTER_NULL_ON_FAILURE flag like this:
$value = ‘car’ ;
$result = filter_var ( $value , FILTER_VALIDATE_BOOLEAN , FILTER_NULL_ON_FAILURE );
?>In the above $result will equal NULL. Without the extra flag it would equal FALSE, which isn’t usually a desired result for this specific filter.
Just to note that «server and env support may not work in all sapi, for filter 0.11.0 or php 5.2.0» as mentioned in Filter tutorial bellow.
The workaround is obvious:
Instead of
$var = filter_input ( INPUT_SERVER , ‘SERVER_NAME’ , FILTER_DEFAULT );
?>
use
$var = filter_var (isset( $_SERVER [ ‘SERVER_NAME’ ]) ? $_SERVER [ ‘SERVER_NAME’ ] : NULL , FILTER_DEFAULT );
?>Beware, the FILTER_SANITIZE_STRING flag functions much like strip_tags, so < will get filtered from input regardless of it's actually part of a tag. We were getting unexepected results with a graphic library we wrote when trying to print < on a dynamic button. The url came in something like ?string=%3C (<) but after filter ran it was empty. To get around this, you could use FILTER_UNSAFE_RAW on that one param.
Below is some code using filter API to restrict access to LAN by IPv4 private address range.
These notes may save someone else a little time:
filter_input_array() is useless for running multiple filters on the same key.
No way to chain or negate filters./* Merciful comment! */
function FILTER_NEGATE_HACK ( $_ )if (! client_is_private_ipv4 ())
exit( ‘This application is restricted to local network users’ );