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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$input_listarray

An array of objects to filter.

$argsarrayoptional

An array of key => value arguments to match against each object. Default empty array.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 value

array

Array of found values.

Performance profile

How much work a call to wp_list_filter() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9

Executed per call on PHP 8.5. The body compiles to 9.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

15

15 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_list_filter() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• wp_filter_object_list()Filters a list of objects, based on a set of key => value arguments.

Used by · 15

• 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_REST_Menu_Items_Controller::get_item_schema()Retrieves the nav menu item's schema, conforming to JSON Schema.
• WP_REST_Menu_Items_Controller::prepare_item_for_response()Prepares a single nav menu item output for response.
• WP_REST_Post_Types_Controller::prepare_item_for_response()Prepares a post type object for serialization.
• WP_REST_Posts_Controller::check_assign_terms_permission()Checks whether current user can assign all terms sent with the current request.
• WP_REST_Posts_Controller::get_available_actions()Gets the link relations available for the post and current user.
• WP_REST_Posts_Controller::get_item_schema()Retrieves the post's schema, conforming to JSON Schema.
• WP_REST_Posts_Controller::get_schema_links()Retrieves Link Description Objects that should be added to the Schema for the posts collection.
• WP_REST_Posts_Controller::handle_terms()Updates the post's terms from a REST request.
• WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
• WP_REST_Posts_Controller::prepare_tax_query()Prepares the 'tax_query' for a collection of posts.
• WP_REST_Posts_Controller::prepare_taxonomy_limit_schema()Prepares the collection schema for including and excluding items by terms.

Source code

View on Trac ↗View on GitHub ↗

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

Changelog

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.