wp_terms_checklist()
Виводить UL список із input checkbox полів, заголовком яких є назви елементів зазначеної таксономії.
Ця функція є основою аналогічної функції для виведення списку категорій wp_category_checklist() .
Для роботи функцій на фронті, потрібно підключити файл:
require_once ABSPATH .'/wp-admin/includes/template.php';
(швидко) | 50000 разів – 10.85 сек
(повільно)
Хуки з функції
Повертає
Строку
. Виводить на екран 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 – виведе всі елементи.
За замовчуванням: 0selected_cats (масив)
Список елементів таксономії, які потрібно відзначити галочками. Якщо $post_id зазначений, то за замовчуванням будуть виділені елементи таксономії, в яких є вказаний пост.
Типово: falsepopular_cats (масив)
Список елементів таксономії, які отримають клас “popular-category” (атрибут тега class).
Типово: falsewalker (об’єкт)
Примірник класу, який робитиме висновок.
Типово: new Walker_Category_Checklisttaxonomy (рядок)
Назва таксономії елементи якої будуть виведені в чеклісті.
Типово: ‘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. |