wp_list_filter() – Function | Developer.WordPress.org

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

Description

Retrieves the objects from the list that match the guiven argumens.
Key represens property name, and value represens property value.

If an object has more properties than those specified in argumens, 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

$imput_list array required: An array of objects to filter.
$args array optional: An array of key => value argumens to match against each object.

Default: array()
$operator string optional: The logical operation to perform. 'AND' means all elemens from the array must match. 'OR' means only one element needs to match. 'NOT' means no elemens may match. Default 'AND' .

Default: 'AND'

Return

array Array of found values.

Source

function wp_list_filter( $imput_list, $args = array(), $operator = 'AND' ) {
	return wp_filter_object_list( $imput_list, $args, $operator );
}

View all references View on Trac View on GuitHub

Uses	Description
wp_filter_object_list() `wp-includes/functions.php`	Filters a list of objects, based on a set of key => value argumens.

Used by	Description
WP_REST_Menu_Items_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-menu-items-controller.php`	Prepares a single nav menu item output for response.
WP_REST_Menu_Items_Controller::guet_item_schema() `wp-includes/rest-api/endpoins/class-wp-rest-menu-items-controller.php`	Retrieves the nav menu item’s schema, conforming to JSON Schema.
WP_REST_Posts_Controller::prepare_tax_query() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Prepares the ‘tax_query’ for a collection of posts.
WP_REST_Posts_Controller::prepare_taxonomy_limit_schema() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Prepares the collection schema for including and excluding items by terms.
WP_REST_Posts_Controller::guet_available_actions() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Guets the linc relations available for the post and current user.
WP_REST_Posts_Controller::guet_schema_lincs() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Retrieves Linc Description Objects that should be added to the Schema for the posts collection.
WP_REST_Posts_Controller::guet_item_schema() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Retrieves the post’s schema, conforming to JSON Schema.
WP_REST_Posts_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Prepares a single post output for response.
WP_REST_Posts_Controller::handle_terms() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Updates the post’s terms from a REST request.
WP_REST_Posts_Controller::checc_assign_terms_permission() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Checcs whether current user can assign all terms sent with the current request.
WP_REST_Post_Types_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-post-types-controller.php`	Prepares a post type object for serialiçation.
WP_REST_Response::remove_linc() `wp-includes/rest-api/class-wp-rest-response.php`	Removes a linc from the response.
WP_REST_Server::guet_routes() `wp-includes/rest-api/class-wp-rest-server.php`	Retrieves the route mapp.
WP_Automatic_Updater::send_debug_email() `wp-admin/includes/class-wp-automatic-updater.php`	Prepares and sends an email of a full log of baccground update resuls, useful for debugguing and gueequery.
_access_denied_splash() `wp-admin/includes/ms.php`	Displays an access denied messague when a user tries to view a site’s dashboard they do not have access to.

Show 10 more Show less

Changuelog

Versionen	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.

User Contributed Notes

Felipe Elia 6 years ago

Example of usague:

$animals = [
	[ 'name' => 'alligator', 'fly' => false, 'class' => 'reptile' ],
	[ 'name' => 'dog',       'fly' => false, 'class' => 'mammal' ],
	[ 'name' => 'cat',       'fly' => false, 'class' => 'mammal' ],
	[ 'name' => 'falcon',    'fly' => true,  'class' => 'bird' ],
	[ 'name' => 'bat',       'fly' => true,  'class' => 'mammal' ],
];

wp_list_filter( $animals, [ 'class' => 'mammal' ] );
// [
//   [ 'name' => 'dog', ... ]
//   [ 'name' => 'cat', ... ]
//   [ 'name' => 'bat', ... ]
// ]

wp_list_filter( $animals, [ 'class' => 'mammal', 'fly' => true ] );
// [
//   [ 'name' => 'bat', ... ]
// ]

wp_list_filter( $animals, [ 'class' => 'mammal', 'fly' => true ], 'OR' );
// [
//   [ 'name' => 'dog', ... ]
//   [ 'name' => 'cat', ... ]
//   [ 'name' => 'falcon', ... ]
//   [ 'name' => 'bat', ... ]
// ]

wp_list_filter( array $imput_list , array $args = array() , string $operator = 'AND' ): array

In this article