WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_list_filter()

wp_list_filter( array $input_list, array $args = array(), string $operator = ‘AND’ ): array

In this article

Back to top

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

$input_listarrayrequired
An array of objects to filter.
$argsarrayoptional
An array of key => value arguments to match against each object.

Default:array()

$operatorstringoptional
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 'AND'.

Default:'AND'

Return

array Array of found values.

Source

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

View all references View on Trac View on GitHub

UsesDescription
wp_filter_object_list()wp-includes/functions.php

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

Used byDescription
WP_REST_Menu_Items_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php

Prepares a single post output for response.

WP_REST_Menu_Items_Controller::get_item_schema()wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php

Retrieves the term’s schema, conforming to JSON Schema.

WP_REST_Posts_Controller::prepare_tax_query()wp-includes/rest-api/endpoints/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/endpoints/class-wp-rest-posts-controller.php

Prepares the collection schema for including and excluding items by terms.

WP_REST_Posts_Controller::get_available_actions()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Gets the link relations available for the post and current user.

WP_REST_Posts_Controller::get_schema_links()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Retrieves Link Description Objects that should be added to the Schema for the posts collection.

WP_REST_Posts_Controller::get_item_schema()wp-includes/rest-api/endpoints/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/endpoints/class-wp-rest-posts-controller.php

Prepares a single post output for response.

WP_REST_Posts_Controller::handle_terms()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Updates the post’s terms from a REST request.

WP_REST_Posts_Controller::check_assign_terms_permission()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Checks 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/endpoints/class-wp-rest-post-types-controller.php

Prepares a post type object for serialization.

WP_REST_Response::remove_link()wp-includes/rest-api/class-wp-rest-response.php

Removes a link from the response.

WP_REST_Server::get_routes()wp-includes/rest-api/class-wp-rest-server.php

Retrieves the route map.

WP_Automatic_Updater::send_debug_email()wp-admin/includes/class-wp-automatic-updater.php

Prepares and sends an email of a full log of background update results, useful for debugging and geekery.

_access_denied_splash()wp-admin/includes/ms.php

Displays an access denied message when a user tries to view a site’s dashboard they do not have access to.

Show 10 moreShow less

Changelog

VersionDescription
5.9.0Converted into a wrapper for wp_filter_object_list().
4.7.0Uses WP_List_Util class.
3.1.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Felipe Elia
    You must log in to vote on the helpfulness of this noteVote results for this note: 9You must log in to vote on the helpfulness of this note

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

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