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.
Description Description
Parameters 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 value: array()
- $operator
-
(string) (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 value: 'and'
- $field
-
(bool|string) (Optional) A field from the object to place instead of the entire object.
Default value: false
Return Return
(array) A list of objects or object fields.
Source 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();
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 4.7.0 | Uses WP_List_Util class. |
| 3.0.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Filtering out certain post types from the loop following a search
If multiple post types are returned in a search query you can filter out the posts that are of post type ‘page’ only.