get_term_field()

2.3.0 wp-includes / taxonomy.php / Кодекс WordPress

Возвращает значение одного из полей термина или, иными словами, одно из свойств объекта WP_Term. Значения очищаются функцией sanitize_term_field() в зависимости от контекста использования.

Читайте подробнее про очистку в этом уроке.

Возвращает объект класса WP_Error, если во второй параметр функции передано пустое значение, либо null, если указанного термина или указанного поля у термина не существует.

get_term_field( $field, $term, $taxonomy = '', $context = 'display' )

Параметры

$field

(строка) Название поля/свойства. Может принимать значения:

term_id – ID рубрики/метки/элемента таксономии
name – название
slug – ярлык
term_group – значение term_group из базы данных (особого применения пока что нет, в основном — в плагинах)
term_taxonomy_id – ID таксономии
taxonomy – название таксономии
description – описание элемента (можно заполнить в админке при создании и редактировании)
parent – ID родительского элемента
count – количество записей
order – номер по порядку при ручной сортировке

$term

(целое|WP_Term) ID или объект элемента таксономии.

$taxonomy

(строка) Название таксономии, которое можно не указывать, если в предыдущем параметре был передан объект.

$context

(строка) Контекст использования. Подробнее о контекстах и их очистке здесь.

Примеры

Начнём с примера, когда функция вернёт ошибку WP_Error. На её наличие мы кстати проверяем функцией is_wp_error().

// допустим, что где-то в коде у нас $term_id получился пустым
$term_id = null;
 
$description = get_term_field( 'description', $term_id, 'category' );
if( is_wp_error( $description ) ) {
	echo $description->get_error_message(); // выведет "Пустой элемент"
} else {
	echo $description;
}

Хорошо, допустим, что $term_id не пустой:

$term_id = 14;
 
$description = get_term_field( 'description', $term_id, 'category' ); // получаем поле
// если мы не знаем, существует ли $term_id или нет, то можем ещё и на ошибку проверить
// if( $description && ! is_wp_error( $description ) )
if( $description ) {
	echo $description;
} else {
	echo 'Либо термина не существует, либо описания у него не существует.';
}

А теперь добрались до очистки. Предположим, что в описании рубрики у нас есть какие-то HTML-теги, что в принципе вполне нормально. Что же выведет функция?

// допустим, что описание такое: 
// Это какое-то описание <strong>рубрики</strong>
 
// выводим его сразу
echo get_term_field( 'description', 14, 'category', 'edit' );
// Это какое-то описание &lt;strong&gt;рубрики&lt;/strong&gt;

Кодекс WordPress: Таксономии: add_term_meta(), edit_term_link(), get_ancestors(), get_edit_term_link(), get_taxonomies(), get_taxonomy(), get_term(), get_term_by(), get_term_children(), get_term_field(), get_term_link(), get_term_meta(), get_term_parents_list(), get_terms(), get_the_term_list(), get_the_terms(), is_object_in_term(), is_tax(), is_taxonomy_hierarchical(), register_taxonomy(), register_taxonomy_for_object_type(), sanitize_term(), sanitize_term_field(), single_term_title(), taxonomy_exists(), term_description(), term_exists(), term_is_ancestor_of(), the_terms(), unregister_taxonomy(), unregister_taxonomy_for_object_type(), update_term_meta(), wp_count_terms(), wp_delete_term(), wp_get_object_terms(), wp_get_post_terms(), wp_get_term_taxonomy_parent_id(), wp_insert_term(), wp_set_object_terms(), wp_update_term()

Миша

Впервые познакомился с WordPress в 2009 году. Организатор и спикер на конференциях WordCamp. Преподаватель в школе Нетология.

Пишите, если нужна помощь с сайтом или разработка с нуля.

Параметры
Примеры