wppaste
WordPress

wp_filter_object_list( array $input_list, array $args = array(), string $operator = 'and', bool|string $field = false ): array

Since
3.0.0, 4.7.0
Source
wp-includes/functions.php:5419
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.

When using the $field argument, this function can also retrieve a particular field from all matching objects, whereas wp_list_filter() only does the filtering.

Compatibility

WordPress
since 4.7.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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'
$fieldbool|stringoptional
A field from the object to place instead of the entire object. Default false.Default: false

Return value

array
A list of objects or object fields.

Performance profile

How much work a call to wp_filter_object_list() 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
7–21

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 22.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
9

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

What one call costs · 3 distinct outcomes

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

WhenInstructionsCalls it makes
!is_array($input_list)7none
is_array($input_list)18->filter(), ->get_output()
is_array($input_list)21->filter(), ->pluck(), ->get_output()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 22 instructions, 7–21 executed per call, 2 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Used by · 9

Source code

View on Trac View on GitHub 

function wp_filter_object_list( $input_list, $args = array(), $operator = 'and', $field = false ) {	if ( ! is_array( $input_list ) ) {		return array();	} 	$util = new WP_List_Util( $input_list ); 	$util->filter( $args, $operator ); 	if ( $field ) {		$util->pluck( $field );	} 	return $util->get_output();}

Changelog

Introduced in 3.0.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.

4.7.0
Uses WP_List_Util class.from the docblock
3.0.0
Introduced.from the docblock

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.