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

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

Contents

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

Top ↑

Return Return

(array) Array of found values.

Top ↑

Source Source

File: wp-includes/functions.php 

function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
	if ( ! is_array( $list ) ) {
		return array();
	}

	$util = new WP_List_Util( $list );
	return $util->filter( $args, $operator );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_tax_query()

Prepares the ‘tax_query’ for a collection of posts.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_taxonomy_limit_schema()

Prepares the collection schema for including and excluding items by terms.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::get_available_actions()

Get the link relations available for the post and current user.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::get_schema_links()

Retrieve Link Description Objects that should be added to the Schema for the posts collection.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::get_item_schema()

Retrieves the post’s schema, conforming to JSON Schema.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()

Prepares a single post output for response.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::handle_terms()

Updates the post’s terms from a REST request.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::check_assign_terms_permission()

Checks whether current user can assign all terms sent with the current request.
wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php: WP_REST_Post_Types_Controller::prepare_item_for_response()

Prepares a post type object for serialization.
wp-includes/rest-api/class-wp-rest-response.php: WP_REST_Response::remove_link()

Removes a link from the response.
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::get_routes()

Retrieves the route map.
wp-admin/includes/class-wp-automatic-updater.php: WP_Automatic_Updater::send_debug_email()

Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
wp-admin/includes/ms.php: _access_denied_splash()

Displays an access denied message when a user tries to view a site’s dashboard they do not have access to.
Show 8 more used by Hide more used by

Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Uses WP_List_Util class.
3.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
    Contributed by Felipe Elia —

    Example of usage:

    $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', ... ]
// ]

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.