wp_terms_checklist()
Выводит UL список из input checkbox полей, заголовком которых является названия элементов указанной таксономии.
Эта функция лежит в основе аналогичной функции для вывода списка категорий wp_category_checklist().
Для работы фукнции на фронте, нужно подключить файл:
require_once ABSPATH .'/wp-admin/includes/template.php';
Хуки из функции
Возвращает
Строку
. Выводит на экран HTML код.
Шаблон использования
wp_terms_checklist( $post_id, [ 'descendants_and_self' => 0, 'selected_cats' => false, 'popular_cats' => false, //'walker' => null, 'taxonomy' => 'category', 'checked_ontop' => true, 'echo' => true, ] );
Использование
wp_terms_checklist( $post_id, $args );
- $post_id(число)
- ID поста для которого выстраивается список элементов таксономии.
По умолчанию: 0 - $args(массив/строка)
Массив параметров для создания списка. Возможные значения:
-
descendants_and_self(число)
ID элемента таксономии, когда нужно вывести дочерние элементы таксономии указанного элемента. 0 - выведет все элементы.
По умолчанию: 0 -
selected_cats(массив)
Список элементов таксономии, которые нужно отметить галочками. Если $post_id указан, то по умолчанию будут выделены элементы таксономии в которых есть указанный пост.
По умолчанию: false -
popular_cats(массив)
Список элементов таксономии, которые получат класс "popular-category" (атрибут тега class).
По умолчанию: false -
walker(объект)
Экземпляр класса, который будет строить вывод.
По умолчанию: new Walker_Category_Checklist -
taxonomy(строка)
Название таксономии элементы которой будут выведены в чеклисте.
По умолчанию: 'category' -
checked_ontop(логический)
true - поместить выделенные элементы наверх списка. Элементы будут помещены вверх даже есть они являются вложенными элементами другого элемента (древовидность нарушается).
По умолчанию: true - echo(логический)
true - выводить на экран. false - возвращать для обработки. С версии 4.4.
По умолчанию: true
-
Примеры
#1 Получим чеклист элементов таксономии
Допустим у нас есть таксономия 'wpfunc' и нам нужно вывести список чекбоксов элемента 51 и всех его дочерних элементов. Также укажем выделенные и популярные элементы.
require_once ABSPATH .'/wp-admin/includes/template.php'; $args = array( 'descendants_and_self' => 51, 'selected_cats' => array(219, 52), 'popular_cats' => array(219, 52), 'taxonomy' => 'wpfunc', 'checked_ontop' => true ); echo '<ul>'; wp_terms_checklist( 0, $args ); echo '</ul>';
Выведет:
<ul> <li id='wpfunc-52' class="popular-category"> <label class="selectit"><input value="52" type="checkbox" name="tax_input[wpfunc][]" id="in-wpfunc-52" checked='checked' /> Комментарии</label> </li> <li id='wpfunc-219' class="popular-category"> <label class="selectit"><input value="219" type="checkbox" name="tax_input[wpfunc][]" id="in-wpfunc-219" checked='checked' /> Пагинация комментариев</label> </li> <li id='wpfunc-51'> <label class="selectit"><input value="51" type="checkbox" name="tax_input[wpfunc][]" id="in-wpfunc-51" /> Комментарии, Пинги...</label> <ul class='children'> <li id='wpfunc-218'> <label class="selectit"><input value="218" type="checkbox" name="tax_input[wpfunc][]" id="in-wpfunc-218" /> Циклы комментариев</label> </li> </ul> </li> </ul>
Список изменений
С версии 3.0.0 | Введена. |
С версии 4.4.0 | Introduced the $echo argument. |