Получает элементы (термины) указанной таксономии по указанным параметрам.
До версии WP 4.5 первый параметр get_terms() был названием таксономии или списком таких названий:
$terms = get_terms("post_tag", [ "hide_empty" => false, ]);
С версии WP 4.5 название таксономии нужно указывать в элементе массива taxonomy в параметре $args , а не во втором параметре, как это было раньше:
$terms = get_terms([ "taxonomy" => "post_tag", "hide_empty" => false, ]);
Обратная совместимость работает (функция понимает устарелый вызов).
C версии 4.6. появился класс мета запросов WP_Term_Query{} . И теперь функция get_terms() является оберткой для этого класса.
✈ 1 раз = 0.015166с = тормоз | 50000 раз = 33.29с = очень медленно | PHP 7.1.11, WP 4.9.5
ВозвращаетМассив/WP_Error/строка.
- Массив объектов WP_Term - при успешном получении.
- array() (пустой массив) - если термины не найдены.
- WP_Error - если любой из указанных таксономий не существует.
- Количество найденных терминов (в виде строки) - если fields = count .
Аргументы, в соответствии с которыми будет получен результат.
Среди них обязательным является аргумент $args["taxonomy"] в котором указывается название таксономии или несколько названий таксономий в массиве.
$deprecated(строка/массив)
До версии 4.5 в этом аргументе указывались параметры $args, а первом параметре $args указывались называния таксономий. С версии 4.5 названия таксономий указываются в аргументе $args["taxonomy"] .
По умолчанию: массив аргументов по умолчанию
По умолчанию: все . object_ids(число/массив)
Укажите тут число или массив чисел, чтобы получить термины, у которых поле object_id таблицы wp_term_relationships совпадет с указанными значениями.
Обычно в поле object_id находятся ID записей к которым прикреплен термин.
Include(строка/массив)
ID терминов, которые нужно включить в выборку. Если указать этот параметр, то многие другие станут бесполезными. Парсится через wp_parse_id_list() .
По умолчанию: ""
exclude(строка/массив)
ID терминов, которые нужно исключить. Парсится через wp_parse_id_list() .
По умолчанию: ""
exclude_tree(строка/массив)
ID родительских терминов, которые нужно исключить. Исключена будет вся ветка.
Парсится через wp_parse_id_list() .
По умолчанию: ""
offset(число)
Верхний отступ в запросе. Сколько первых элементов пропустить. Указывать нужно число. По умолчанию без отступов.
orderby(строка)
Поле по которому сортировать результат. Может быть:
- id или term_id - по ID.
- name - по названию. По умолчанию.
- count - по полю count в term_taxonomy - по количеству записей.
- slug - по альтернативному названию.
- description - по описанию.
- term_group - по группе.
- include - по порядку указанному в параметре $include
- slug__in - с версии 4.9. В порядке указанном в параметре $slug.
- meta_value - по значению произвольного поля
- meta_value_num - по значению произвольного поля, значение будет интерпретироваться как число, а не строка.
- ключ "meta_query" - в параметре $meta_query мы можем указать параметры запроса по метаполям, и там же указать ключ для конкретного запроса. Этот ключ можно использовать как ключ для сортировки по соответствующему метаполю.
- none - не сортировать
parent - по полю parent.
По умолчанию: "id"
order(строка)Направление сортировки, указанной в параметре "orderby":
- ASC - по порядку, от меньшего к большему (1, 2, 3; a, b, c);
- DESC - в обратном порядке, от большего к меньшему (3, 2, 1; c, b, a).
По умолчанию: "ASC"
Hide_empty(логический)
Скрывать ли термины в которых нет записей. 1(true) - скрывать пустые, 0(false) - показывать пустые.
По умолчанию: true
fields(строка)
Какие поля возвращать в результирующем массиве. Может быть:
- all - Вернуть массив объектов (все данные) - по умолчанию;
- ids - вернуть массив чисел;
- names - вернуть массив строк.
- count - (3.2+) возвращает количество найденных терминов.
- id=>parent - вернуть массив, где ключ = ID термина, а значение = ID родительского термина.
- id=>slug - вернуть массив, где ключ = ID термина, а значение = слаг (название для УРЛ) термина.
- id=>name - вернуть массив, где ключ = ID термина, а значение = название (имя) термина.
По умолчанию: "all"
count(логический) true - вернет количество терминов. В этом случае, перебивает параметр fields .false - вернет массив объектов терминов. name(строка/массив) Укажите тут строку или массив строк, чтобы получить термины с указанными названиями.
По умолчанию: "" slug(строка/массив) Укажите тут строку или массив строк, чтобы получить термины с указанными ярлыками (слагами).
По умолчанию: "" hierarchical(логический)
Включать ли в результат термины, которые имеют не пустые дочерние термины (в которых есть записи). Т.е. в массив будут включены пустые термины, если у их дочерних терминах есть записи, даже если аргумент " hide_empty " равен true .
- true - да, включить;
- false - нет, не включать.
По умолчанию: true
Search(строка)
Поиск по названиям термина и его ярлыку. Получит термины в названиях которых есть вхождение указанной тут строки. Т.е. запрос выглядит так: LIKE "%search_string%" .
По умолчанию: ""
name__like(строка)
Показать термины, в названии которых есть указанная строка. Поиск по строке.
По умолчанию: ""
description__like (строка)
Показать термины, в описании которых есть указанная строка. Поиск по строке.
По умолчанию: ""
pad_counts(логический)
Если передать true, то число которое показывает количество записей в родительских категориях будет суммой своих записей и записей из дочерних категорий. По умолчанию подсчитываются только свои записи.
pad_counts зависит от параметра parent потому что подсчет записей идет на уровне PHP и если например указать parent=0 , то будут получены только верхние термины и pad_counts не сможет правильно посчитать кол-во записей в дочерних терминах. Чтобы обойти это ограничение, нужно получить все термины, не указывая parent , а потом в PHP удалить ненужные... Вот пример такого кода:
$terms = get_terms(array("hide_empty" => 0, "orderby" => "name", "order" => "ASC", "taxonomy" => "category", "pad_counts" => 1)); // оставим только термины с parent=0 $terms = wp_list_filter($terms, array("parent"=>0));
По умолчанию: false
get(строка)Если указать "all" то будут жёстко отключены параметры: childless , child_of , hide_empty , hierarchical и pad_counts . "Жёстко" - значит перебьет текущие установки для этих параметров. "Отключены" - значит им будет установлен параметр false или 0.
Обычно используется для удобства, когда нужно получить термины на низком уровне, не для вывода, а для дальнейшей работы с ними, чтобы не следить за значениями упомянутых параметров...
// фрагмент кода if ("all" == $args["get"]) { $args["childless"] = false; $args["child_of"] = 0; $args["hide_empty"] = 0; $args["hierarchical"] = false; $args["pad_counts"] = false; }
По умолчанию: ""
child_of(число)ID родительского термина. Вывести элементы таксономии, которые являются дочерними разделами указанного элемента. Будут получены все уровни вложенности, все дерево.
Если указаны несколько таксономий, параметр будет проигнорирован.
По умолчанию: 0
Parent(число)
ID родительского термина, чтобы получить только прямых потомков.
Будет получен только первый уровень вложенности, а не все дерево как в параметре child_of . Если указать 0, то будут выведены термины верхнего уровня.
По умолчанию: ""
Term_taxonomy_id(число/массив)
Укажите тут число или массив чисел, чтобы получить термины, у которых поле term_taxonomy_id совпадет с указанными значениями.
По умолчанию: ""
cache_domain(строка)
(3.2+) Позволяет установить уникальные ключ кэша, который будет использоваться в get_terms() при объектном кэшировании (object cache). Например, если вы используется один из фильтров get_terms(), чтобы изменить запрос (например "terms_clausses"), установив "cache_domain" в уникальное значение, позволить не перезаписывать сохраненный кэш для одинаковых запросов.
По умолчанию: "core"
update_term_meta_cache(логический)
true - загрузить кэш метаданных, чтобы потом их можно было быстро получить. Кэш подгружается для полученных элементов.
По умолчанию: true
meta_query(массив)
Запрос для получения элементов на основе метаданных. Смотрите WP_Meta_Query .
meta_key(строка)
Получит термины у которых есть указанное метаполе. Можно использовать в связке с meta_value .
По умолчанию: ""
meta_value(строка)
Получит термины у которых значение метаполя равно указанному значению. Всегда используется в связке с meta_key .
По умолчанию: ""
suppress_filter(логический)
Подавлять работу фильтров или нет? Если выставить в true, то фильтр get_terms просто не будет работать для текущего запроса терминов.
По умолчанию: false (фильтры работают)
Данные в массиве будут отсортированы по количеству записей (orderby=count) в каждой категории. Категории у которых нет записей все равно будут включены в массив (hide_empty=0).
$myterms = get_terms("category", "orderby=count&hide_empty=0");
#2 Выведем на экран список названий всех разделов таксономии "my_taxonomy": $terms = get_terms("my_taxonomy"); if($terms && ! is_wp_error($terms)){ echo "- ";
foreach($terms as $term){
echo "
- ". $term->name ." "; } echo "
В данном примере каждый $term из цикла foreach($terms as $term) , будет содержать такую информацию:
=> 162 => Здоровье => zdorove => 0 => 170 => my_taxonomy => => 0 => 2
#3 Вывод рубрик через разделитель// получаем все термины из таксономии my_term $args = array("hide_empty=0"); $terms = get_terms("my_term", $args); // собираем их и выводим if (!empty($terms) && !is_wp_error($terms)) { $count = count($terms); $i=0; $term_list = "
"; foreach ($terms as $term) { $i++; $term_list .= "name) . "">" . $term->name . ""; if ($count != $i) { $term_list .= " · "; } else { $term_list .= "
"; } } echo $term_list; } /* в итоге получим подобный код: */ Список изменений| С версии 2.3.0 | Введена. |
| С версии 4.2.0 | Introduced "name" and "childless" parameters. |
| С версии 4.4.0 | Introduced the ability to pass "term_id" as an alias of "id" for the orderby parameter. Introduced the "meta_query" and "update_term_meta_cache" parameters. Converted to return a list of WP_Term objects. |
| С версии 4.5.0 | Changed the function signature so that the $args array can be provided as the first parameter. Introduced "meta_key" and "meta_value" parameters. Introduced the ability to order results by metadata. |
| С версии 4.8.0 | Introduced "suppress_filter" parameter. |
