wp_list_filter() WordPress Function
The wp_list_filter() function is used to filter a list of objects, based on specified criteria. The function takes two arguments: the list of objects to filter, and an array of criteria. The function will return a new list of objects, which contains only those objects that match the criteria.
wp_list_filter( array $list, array $args = array(), string $operator = 'AND' ) #
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.
If you want to retrieve a particular field from all matching objects, use wp_filter_object_list() instead.
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. 'AND' means all elements from the array must match. 'OR' means only one element needs to match. 'NOT' means no elements may match.
Default value: 'AND'
Return
(array) Array of found values.
Source
File: wp-includes/functions.php
function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
return wp_filter_object_list( $list, $args, $operator );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.9.0 | Converted into a wrapper for wp_filter_object_list(). |
| 4.7.0 | Uses WP_List_Util class. |
| 3.1.0 | Introduced. |