get_term_field() — описание функции WordPress на русском

Сигнатура

get_term_field( string $field, int|WP_Term $term, string $taxonomy = '', string $context = 'display' ): string|int|null|WP_Error

Описание

Функция существует по контекстным соображениям и для простоты использования.
См. alsosanitize_term_field()

Оригинал (английский)

The function is for contextual reasons and for simplicity of usage.

Параметры

$field string обязательный

Поле термина для получения.

$term int|WP_Term обязательный

ID или объект термина.

$taxonomy string необязательный = ''

Имя таксономии.

$context string необязательный = 'display'

Как очищать поля термина. Доступные варианты см. в sanitize_term_field(). Значение по умолчанию 'display'.

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

string|int|null|WP_Error

Исходный код

wp-includes/taxonomy.php:1221

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 );
}

История изменений

Версия	Описание
4.4.0	The $taxonomy parameter was made optional. $term can also now accept a WP_Term object.
2.3.0	Introduced.