Функция get_term_field() в WordPress

Функция get_term_field() позволяет получить очищенное (с очищенными данными) поле термина (категории, тега и т.д.) в WordPress. Это удобно и просто в использовании.

Возвращаемое значение

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

Применение

get_term_field( $field, $term, $taxonomy, $context );

• $field (строка, обязательный параметр): Поле термина, которое необходимо получить.
• $term (целое число или объект WP_Term, обязательный параметр): ID термина или объект термина.
• $taxonomy (строка): Имя таксономии (например, 'category').
• $context (строка): Как очищать поля термина. Дополнительные варианты можно найти в функции sanitize_term_field(). По умолчанию — 'display'.

Примеры

Пример 1: Вывод описания категории 34

Описание можно задать в панели администратора при создании или изменении категории. Если описание отсутствует, будет выведено сообщение "Описание термина не найдено".

$description = get_term_field( 'description', 34, 'category' );

if( is_wp_error( $description ) ) {
    echo 'Описание термина не найдено';
} else {
    echo $description;
}

Заметки

• Смотрите функцию: sanitize_term_field() для получения дополнительной информации.

Лог изменений

• С версии 2.3.0: Функция была введена.
• С версии 4.4.0: Параметр $taxonomy стал необязательным. Теперь можно передавать объект WP_Term в качестве значения $term.

Код функции

Код функции get_term_field находится в файле wp-includes/taxonomy.php:

function get_term_field( $field, $term, $taxonomy = '', $context = 'display' ) {
$term = get_term( $term, $taxonomy );
if ( is_wp_error( $term ) ) {
return $term;
}

if ( ! is_object( $term ) ) {
    return '';
}

if ( ! isset( $term->$field ) ) {
    return '';
}

return sanitize_term_field( $field, $term->$field, $term->term_id, $term->taxonomy, $context );

}

Связанные функции

• category_exists()
• get_term()
• get_term_by()
• get_term_children()
• get_term_link()
• get_terms()
• get_the_term_list()
• get_the_terms()
• has_term()
• is_object_in_term()
• tag_exists()
• the_terms()
• wp_delete_object_term_relationships()
• wp_delete_term()
• wp_get_object_terms()
• wp_get_term_taxonomy_parent_id()
• wp_insert_category()
• wp_insert_term()
• wp_set_object_terms()
• wp_set_post_terms()
• WP_Tax_Query()
• WP_Term()
• WP_Term_Query()
• wp_update_term()
• wp_update_term_count()

Таксономии: категории, теги

• edit_term_link()
• get_edit_term_link()
• get_taxonomies()
• get_taxonomy()
• 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()
• unregister_taxonomy()
• unregister_taxonomy_for_object_type()
• wp_count_terms()

Эта информация о функци�� get_term_field() поможет вам максимально эффективно использовать эту функцию в вашей работе с WordPress.