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

Get sanitized Term field.

Description

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

Parameters

$field

(Required) Term field to fetch.

$term

(Required) Term ID or object.

$taxonomy

(Optional) Taxonomy Name.

Default value: ''

$context

(Optional) default is display. Look at sanitize_term_field() for available options.

Default value: 'display'

Return

(string|int|null|WP_Error) Will return an empty string if $term is not an object or if $field is not set in $term.

Source

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

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/load.php: is_wp_error()	Check whether variable is a ClassicPress Error.
wp-includes/taxonomy.php: sanitize_term_field()	Cleanse the field value in the term based on the context.
wp-includes/taxonomy.php: get_term()	Get all Term data from database by Term ID.

Used By

Used By
Used By	Description
wp-includes/customize/class-wp-customize-nav-menu-item-setting.php: WP_Customize_Nav_Menu_Item_Setting::get_original_title()	Get original title.
wp-includes/nav-menu.php: wp_update_nav_menu_item()	Save the properties of a menu item or create a new one.
wp-includes/nav-menu.php: wp_setup_nav_menu_item()	Decorates a menu item object with the shared navigation menu item properties.
wp-includes/category-template.php: term_description()	Retrieve term description.
wp-admin/includes/class-walker-nav-menu-edit.php: Walker_Nav_Menu_Edit::start_el()	Start the element output.

Changelog

Changelog
Version	Description
WP-4.4.0	The `$taxonomy` parameter was made optional. `$term` can also now accept a WP_Term object.
WP-2.3.0	Introduced.