wp_filter_object_list( array $list, array $args = array(), string $operator = 'and', bool|string $field = false ): 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.

When using the $field argument, this function can also retrieve a particular field from all matching objects, whereas wp_list_filter() only does the filtering.


Top ↑

Parameters

$list array Required
An array of objects to filter.
$args array Optional
An array of key => value arguments to match against each object.

Default: array()

$operator string Optional
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'

$field bool|string Optional
A field from the object to place instead of the entire object.

Default: false


Top ↑

Return

array A list of objects or object fields.


Top ↑

Source

File: wp-includes/functions.php. View all references

function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
	if ( ! is_array( $list ) ) {
		return array();
	}

	$util = new WP_List_Util( $list );

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

	if ( $field ) {
		$util->pluck( $field );
	}

	return $util->get_output();
}


Top ↑

Changelog

Changelog
Version Description
4.7.0 Uses WP_List_Util class.
3.0.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.