array_filter

PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
array_filter - Filters elements of an array using a callback function
Manual
Code Examples

array_filter( array$array, [callable|null$callback = null], [int$mode = 0] ): array

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

array

The array to iterate over

callback

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.

mode

Flag determining what arguments are sent to callback:

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

Default is 0 which will pass value as the only argument to callback instead.

Return Values

Returns the filtered array.

Notes

Caution:

If the array is changed from the callback function (e.g. element added, deleted or unset) the behavior of this function is undefined.

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.

Related Functions

Example of array_filter

Show all examples for array_filter

PHP Version:


Function array_filter:

Arrays Functions

Most used PHP functions