get_term_field()
Отримує поле терміна. Поле очищається функцією sanitize_term_field().
Поле перевіряється наявність перед отриманням. Функція створена для зручності використання у контексті.
Працює на основі:
sanitize_term_field()
sanitize_term_field()
Основа для:
term_description()
term_description()
Хуків немає.
Повертає
Строку|int|null|WP_Error
. Поверне порожній рядок, якщо $term не є об’єктом або якщо поле $field не знайдено у терміна ($term).
Використання
get_term_field( $field, $term, $taxonomy, $context );
-
$field
(рядок) (обов’язковий) - Поле терміна, яке необхідно отримати.
-
$term
(число/об’єкт) (обов’язковий) -
ID термін. З версії 4.4. можна передавати об’єкт
WP_Term . -
$taxonomy
(рядок) -
Назва таксономії. З версії 4.4. параметр став необов’язковим.
За замовчуванням: ” -
$context
(рядок) Тип фільтрації. Одне із значень:
raw
– просто поверне значенняedit
– фільтр esc_html() якщо це поле description, та фільтр esc_attr() якщо інше поле.db
slug
rss
attribute
– фільтр esc_attr()js
– фільтр esc_js()
Типово: ‘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 | The $taxonomy parameter був зроблений optional. $term може також зараз accept a WP_Term object. |
Код get_term_field() get term field WP 6.0.2
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 ); }