wp_filter_object_list( array $list, array $args = array(), string $operator = 'and', bool|string $field = false )
Filters a list of objects, based on a set of key => value arguments.
Parameters
- $list
-
(Required) An array of objects to filter
- $args
-
(Optional) An array of key => value arguments to match against each object.
Default value: array()
- $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'.
Default value: 'and'
- $field
-
(Optional) A field from the object to place instead of the entire object.
Default value: false
Return
(array) A list of objects or object fields.
Source
File: wp-includes/functions.php
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();
}
Changelog
| Version | Description |
|---|---|
| WP-4.7.0 | Uses WP_List_Util class. |
| WP-3.0.0 | Introduced. |