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

Description

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

array

A list of objects or object fields.

Uses · 1

• WP_List_Util::__construct()Constructor.

Used by · 9

• WP_Media_List_Table::get_columns()
• WP_Plugin_Install_List_Table::prepare_items()
• WP_Posts_List_Table::get_columns()
• block_core_breadcrumbs_get_terms_breadcrumbs()Generates breadcrumb items from taxonomy terms.
• get_post_stati()Gets a list of post statuses.
• get_post_types()Gets a list of all registered post type objects.
• get_post_types_by_support()Retrieves a list of post type names that support a specific feature.
• get_taxonomies()Retrieves a list of registered taxonomy names or objects.
• wp_list_filter()Filters a list of objects, based on a set of key => value arguments.

Source

View on Trac ↗View on GitHub ↗

5419function wp_filter_object_list( $input_list, $args = array(), $operator = 'and', $field = false ) {5420	if ( ! is_array( $input_list ) ) {5421		return array();5422	}5423 5424	$util = new WP_List_Util( $input_list );5425 5426	$util->filter( $args, $operator );5427 5428	if ( $field ) {5429		$util->pluck( $field );5430	}5431 5432	return $util->get_output();5433}

History

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.

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.