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

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


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. 'or' means only one element from the array needs to match; 'and' means all elements must match; 'not' means no elements may match.

Default value: 'and'

$field

(bool|string) (Optional) A field from the object to place instead of the entire object.

Default value: false


Top ↑

Return Return

(array) A list of objects or object fields.


Top ↑

Source Source

File: wp-includes/functions.php

function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
	if ( ! is_array( $list ) ) {
		return array();
	}

	$util = new WP_List_Util( $list );

	$util->filter( $args, $operator );

	if ( $field ) {
		$util->pluck( $field );
	}

	return $util->get_output();
}


Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Uses WP_List_Util class.
3.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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