Функция wp_terms_checklist() в WordPress: описание, использование, аргументы

# WP_TERMS_CHECKLIST() │ WP 3.0.0

Функция wp_terms_checklist() отображает список элементов в виде маркеров (чекбоксов), где каждый элемент обозначен названием термина (категории или тега).

## Что это такое?

Это функция, которая работает независимо от таксономии, что означает, что она может использоваться для любы�� таксономий, включая категории и теги. Предыдущее название аналогичной функции — wp_category_checklist().

## Подключение файла

Чтобы функция работала на фронтенде (передней части сайта), необходимо подключить файл:

```php
require_once ABSPATH . '/wp-admin/includes/template.php';

Время выполнения

• 1 раз — 0.000455 сек (быстро)
• 50000 раз — 10.85 сек (медленно)

Хуки функции

Опции для функции можно изменить с помощью хуков:

• wp_terms_checklist_args

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

Функция возвращает строку. Если аргумент echo установлен на true, то функция выводит HTML-код. В противном случае она возвращает HTML-код как строку.

Шаблон использования

Пример вызова функции:

wp_terms_checklist($post_id, [
    'descendants_and_self' => 0,
    'selected_cats'        => false,
    'popular_cats'         => false,
    'taxonomy'             => 'category',
    'checked_ontop'        => true,
    'echo'                 => true,
]);

Аргументы

• post_id (int): ID поста, к которому мы привязываем термины.
• args (array|string): Массив или строка аргументов для генерации чеклиста.

По умолчанию используется пустой массив.

1. descendants_and_self (int): ID категории, которую нужно вывести вместе с её подкатегориями.

2. selected_cats (int[]): Массив ID категорий, которые нужно отметить как выбраные. По умолчанию — false.

3. popular_cats (int[]): Массив ID популярных категорий. По умолчанию — false.

4. walker (Walker): Объект, который используется для построения вывода. По умолчанию используется Walker_Category_Checklist.

5. taxonomy (string): Таксономия для генерации чеклиста. По умолчанию — 'category'.

6. checked_ontop (true|false): Переместить выбранные элементы в начало списка. По умолчанию — true.

7. echo (true|false): Вывести сгенерированный HTML-код. Если false, будет возвращен HTML-код, а не выведен. По умолчанию — true.

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

Получение чеклиста элементов таксономии

Предположим, у нас есть таксономия wpfunc, и нам нужно отобразить чекбоксы для элемента с ID 51 и всех его дочерних элементов. Также укажем выделенные и популярные элементы.

require_once ABSPATH . '/wp-admin/includes/template.php';

$args = [
    'descendants_and_self' => 51,
    'selected_cats'        => [219, 52],
    'popular_cats'         => [219, 52],
    'taxonomy'             => 'wpfunc',
    'checked_ontop'        => true,
];

echo '
';
wp_terms_checklist(0, $args);
echo '
';

Вывод

Вывод будет содержать HTML-код следующего вида:

    

        
             Comments
        
    
    

        
             Comment pagination
        
    
    

        
             Comments, Pings...
        
        

            

                
                     Comments Loop
                
            
        
    

Изменения

• С версии 3.0.0: Функция была введена.
• С версии 4.4.0: Добавлен аргумент $echo.

function wp_terms_checklist($post_id = 0, $args = array()) {
    // (функция описана выше)
}

Связанные функции

• get_term_parents_list()
• get_the_term_list()
• wp_dropdown_categories()
• wp_dropdown_pages()
• wp_dropdown_users()
• wp_get_archives()
• wp_list_authors()
• wp_list_categories()