WordPress at Your Fingertips

wp_list_filter() WP 1.0

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

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.

1 time — 0.000001 sec (speed of light) | 50000 times — 0.09 sec (speed of light) | PHP 7.4.8, WP 5.6.2

No Hooks.

Return

Array. Array of found values.

Usage

wp_list_filter( $list, $args, $operator );
$list(array) (required)
An array of objects to filter.
$args(array)
An array of key => value arguments to match against each object.
Default: empty array
$operator(string)
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'

Changelog

Since 3.1.0 Introduced.
Since 4.7.0 Uses WP_List_Util class.

Code of wp_list_filter() WP 5.8.1

function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
	if ( ! is_array( $list ) ) {
		return array();
	}

	$util = new WP_List_Util( $list );

	return $util->filter( $args, $operator );
}

array list help functions (sorting arrays objects)

Helper Functions

No comments
    Log In