W3cubDocs

/WordPress

wp_list_filter( array $input_list, array $args = array(), string $operator = ‘AND’ ): array

Filters a list of objects, based on a set of key => value arguments.

Description

Retrieves the objects from the list that match the given arguments.
Key represents property name, and value represents property value.

If an object has more properties than those specified in arguments, that will not disqualify it. When using the ‘AND’ operator, any missing properties will disqualify it.

If you want to retrieve a particular field from all matching objects, use wp_filter_object_list() instead.

Parameters

$input_listarrayrequired
An array of objects to filter.
$argsarrayoptional
An array of key => value arguments to match against each object.

Default:array()

$operatorstringoptional
The logical operation to perform. 'AND' means all elements from the array must match. 'OR' means only one element needs to match. 'NOT' means no elements may match. Default 'AND'.

Default:'AND'

Return

array Array of found values.

Source

function wp_list_filter( $input_list, $args = array(), $operator = 'AND' ) {
	return wp_filter_object_list( $input_list, $args, $operator );
}

Changelog

Version Description
5.9.0 Converted into a wrapper for wp_filter_object_list().
4.7.0 Uses WP_List_Util class.
3.1.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_list_filter