wp_filter_object_list

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

Description

(array) wp_filter_object_list( (array) $list, (array) $args = array(), (string) $operator = 'and', (bool) $field = false ); 

Returns (array)

A list of objects or object fields.

Parameters (4)

0. $list (array)
An array of objects to filter
1. $args — Optional. (array) => array()
An array of key => value arguments to match against each object. Default empty array.
2. $operator — Optional. (string) => 'and'
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.
3. $field — Optional. (bool) => false
A field from the object to place instead of the entire object. Default false.

Usage

  1. if ( !function_exists( 'wp_filter_object_list' ) ) { 
  2.     require_once ABSPATH . WPINC . '/functions.php'; 
  3. } 
  4.   
  5. // An array of objects to filter 
  6. $list = array(); 
  7.   
  8. // Optional. An array of key => value arguments to match 
  9. // against each object. Default empty array. 
  10. $args = array(); 
  11. $operator = 'and'; 
  12.   
  13. // A field from the object to place instead of the entire object. 
  14. // Default false. 
  15. $field = false; 
  16.   
  17. // NOTICE! Understand what this does before running. 
  18. $result = wp_filter_object_list($list, $args, $operator, $field); 
  19.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/functions.php  
  1. function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) { 
  2.     if ( ! is_array( $list ) ) { 
  3.         return array(); 
  4.     } 
  5.  
  6.     $util = new WP_List_Util( $list ); 
  7.  
  8.     $util->filter( $args, $operator ); 
  9.  
  10.     if ( $field ) { 
  11.         $util->pluck( $field ); 
  12.     } 
  13.  
  14.     return $util->get_output(); 
  15. }