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.

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

Code of wp_list_filter() 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 );
}

Related Functions

array list help functions (sorting arrays objects)

Helper Functions