WP_List_Util: Утилита для работы с массивами в WordPress

Класс WP_List_Util предназначен для выполнения операций с массивами объектов или массивами. Он упрощает работу с массивами и позволяет легко выполнять такие задачи, как фильтрация, сортировка и извлечение данных.

Использование

Чтобы использовать класс, создайте его экземпляр, передав массив данных:

$util = new WP_List_Util($array);

Теперь вы можете использовать методы класса для работы с вашим массивом.

Методы класса

1. Конструктор: __construct($input)

Конструктор инициализирует класс, принимая массив в качестве входных данных.

2. Фильтрация: filter($args = array(), $operator = 'AND')

Этот метод фильтрует массив на основе заданных условий. Аргументы представляют собой массив с ключами и значениями, которые нужно найти:

• $args: массив условий для фильтрации.
• $operator: логическая операция, по умолчанию 'AND' (все элементы должны соответствовать). Возможные значения: 'AND', 'OR', 'NOT'.

Пример использования:

$filtered = $util->filter(['status' => 'active']);

3. Получить входные данные: get_input()

Этот метод возвращает исходный массив, который был передан в класс.

4. Получить вывод: get_output()

Метод возвращает текущий массив с выводом после применения фильтров или других операций.

5. Извлечение поля: pluck($field, $index_key = null)

Этот метод позволяет извлечь определённое поле из каждого элемента массива. Если указан $index_key, то он будет использоваться в качестве ключей для нового массива.

Пример использования:

$names = $util->pluck('name');

6. Сортировка: sort($orderby = array(), $order = 'ASC', $preserve_keys = false)

Метод сортирует массив на основе одного или нескольких полей. Аргументы включают:

• $orderby: имя поля или массив полей для сортировки.
• $order: порядок сортировки ('ASC' – по возрастанию, 'DESC' – по убыванию).
• $preserve_keys: сохранять ли ключи из исходного массива.

Пример сортировки:

$sorted = $util->sort('age', 'DESC');

Примеры использования класса

Пример 1: Использование метода wp_list_pluck

Метод wp_list_pluck позволяет извлекать данные из массива:

function wp_list_pluck($list, $field, $index_key = null) {
    $util = new WP_List_Util($list);
    return $util->pluck($field, $index_key);
}

Пример 2: Создание собственной функции сортировки

Можно создать функцию для сортировки массива:

function sort_array_by_order($array) {
    $util = new WP_List_Util($array);
    $array = $util->filter(['order' => true]);
    return $util->sort('order', 'ASC', true);
}

Изменения

Класс был внедрён в версии WordPress 4.7.0.

Заключение

Класс WP_List_Util предоставляет мощные инструменты для работы с массивами, упрощая фильтрацию, сортировку и извлечение данных. Его можно использовать в различных проектах WordPress для повышения эффективности выполнения операций с массивами.