wp_list_filter() — описание функции WordPress на русском

Сигнатура

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

Описание

Возвращает из списка объекты, соответствующие заданным аргументам.
Ключ представляет имя свойства, а значение — значение свойства.
Если у объекта больше свойств, чем указано в аргументах, это не исключает его из выборки. При использовании оператора 'AND' любое отсутствующее свойство исключает объект.
Если нужно извлечь определённое поле из всех подходящих объектов, используйте вместо этого wp_filter_object_list().

Оригинал (английский)

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.

Параметры

$input_list array обязательный

Массив объектов для фильтрации.

$args array необязательный = array()

Массив аргументов ключ => значение для сопоставления с каждым объектом.

$operator string необязательный = 'AND'

Логическая операция, которую нужно выполнить. 'AND' означает, что должны совпасть все элементы массива. 'OR' означает, что достаточно совпадения одного элемента. 'NOT' означает, что не должен совпасть ни один элемент. Значение по умолчанию 'AND'.

Возвращаемое значение

array

Исходный код

wp-includes/functions.php:5373

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

История изменений

Версия	Описание
5.9.0	Converted into a wrapper for wp_filter_object_list().
4.7.0	Uses WP_List_Util class.
3.1.0	Introduced.