A WordPress-centric search engine for devs and theme authors



wp_filter_object_list ›

Since3.0.0
Deprecatedn/a
wp_filter_object_list ( $list, $args = array(), $operator = 'and', $field = false )
Parameters: (4)
  • (array) $list An array of objects to filter
    Required: Yes
  • (array) $args Optional. An array of key => value arguments to match against each object. Default empty array.
    Required: No
    Default: array()
  • (string) $operator Optional. The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match; 'not' means no elements may match. Default 'and'.
    Required: No
    Default: 'and'
  • (bool|string) $field A field from the object to place instead of the entire object. Default false.
    Required: No
    Default: false
Returns:
  • (array) A list of objects or object fields.
Defined at:
Codex:
Change Log:
  • 4.7.0

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



Source

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