Документация по этой функции находится здесь.
По сути, она возвращает глоссарий всей базы. Если вы аккуратно вели записи WORDPRESS и всюду ставили метки (таги), и база у вас большая, то вызов этой функции может быть ресурсоемким с точки зрения использования памяти сервера, если Вы планируете увидеть у себя большое количество посетителей, то хорошо подумайте, прежде чем использовать эту функцию. Для ограничения вывода, функция имеет несколько настроек.
Пример вызова функции:
В качестве параметра используется массив, выше показан работающий пример, который выводит метки, отсортированные от большего к меньшему количеству постов, которые метке соответствуют.
Описание параметров (значения массива):
orderby — по умолчанию ‘name’. Может быть: ‘name’, ‘count’, или ничего, тогда для сортировки будет использован term_id.
order — по умолчанию ‘ASC’, альтернатива — ‘DESC’.
hide_empty — по умолчанию true. Не будут возвращены метки у которых нет постов.
exclude — по умолчанию пустая строка. Для исключения меток задайте их ID или через пробел или через запятую. Этот параметр отвергается параметром include (если он задан).
include — по умолчанию пустая строка. Если вы хотите обязательно включить в результаты определенные метки, то задайте их ID через запятую или пробелы для этого параметра.
number — это ограничитель количества меток, которые вернет функция, по умолчанию он пустой.
offset — отступ, количество меток, которое будет пропущено при выводе результатов.
fields — по умолчанию стоит ‘all’, в этом случае будет возвращен массив term-объектов. Если указано ‘ids’ или ‘names’, то будет возвращен или целочисленный массив или массив строк (id или name объектов соответственно).
slug — возвращает метки с заданным кодом.
hierarchical — включает метки у которых не пустые потомки, т.е. если включено hide_empty и у метки нет постов, но у ее потомков посты есть, то она будет отображена.
Ниже идет поток сознания разработчиков, примеров мы не нашли, на индусов похоже.
search — Returned terms’ names will contain the value of ‘search’, case-insensitive. Default is an empty string. — дождемся примеров
name__like — Returned terms’ names will begin with the value of ‘name__like’, case-insensitive. Default is empty string. — дождемся примеров.
pad_counts — if set to true will include the quantity of a term’s children in the quantity of each term’s «count» object variable.
get — if set to ‘all’ instead of its default empty string, returns terms regardless of ancestry or whether the terms are empty.
child_of — when used, should be set to the integer of a term ID. Its default is 0. If set to a non-zero value, all returned terms will be descendants of that term according to the given taxonomy. Hence ‘child_of’ is set to 0 if more than one taxonomy is passed in $taxonomies, because multiple taxonomies make term ancestry ambiguous.
parent — argument, when used, should be set to the integer of a term ID. Its default is the empty string, which has a different meaning from the integer 0. If set to an integer value, all returned terms will have as an immediate ancestor the term whose ID is specified by that integer according to the given taxonomy. The ‘parent’ argument is different from ‘child_of’ in that a term X is considered a ‘parent’ of term Y only if term X is the father of term Y, not its grandfather or great-grandfather, etc.
Возвращаемое значение, это пример массива:
(
[0] => stdClass Object
(
[term_id] => 38
[name] => аптеки
[slug] => аптеки–2
[term_group] => 0
[term_taxonomy_id] => 38
[taxonomy] => post_tag
[description] =>
[parent] => 0
[count] => 1
)