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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$fieldstring

Term field to fetch.

$termint|WP_Term

Term ID or object.

$taxonomystringoptional

Taxonomy name. Default empty.Default: ''

$contextstringoptional

How to sanitize term fields. Look at sanitize_term_field() for available options.
Default 'display'.Default: 'display'

Return value

string|int|null|WP_Error

Will return an empty string if $term is not an object or if $field is not set in $term.

Performance profile

How much work a call to get_term_field() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_term().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

14–31

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 34.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

6

6 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_term()called directly
• hookthird-party callbacksapply_filters()one call below get_term_field()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_term_field() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• get_term()Gets all term data from database by term ID.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• sanitize_term_field()Sanitizes the field value in the term based on the context.

Used by · 6

• WP_Customize_Nav_Menu_Item_Setting::get_original_title()Get original title.
• WP_REST_Menu_Items_Controller::prepare_item_for_database()Prepares a single nav menu item for create or update.
• WP_REST_Menu_Items_Controller::prepare_links()Prepares links for the request.
• term_description()Retrieves term description.
• wp_setup_nav_menu_item()Decorates a menu item object with the shared navigation menu item properties.
• wp_update_nav_menu_item()Saves the properties of a menu item or create a new one.

Source code

View on Trac ↗View on GitHub ↗

1221function get_term_field( $field, $term, $taxonomy = '', $context = 'display' ) {1222	$term = get_term( $term, $taxonomy );1223	if ( is_wp_error( $term ) ) {1224		return $term;1225	}1226 1227	if ( ! is_object( $term ) ) {1228		return '';1229	}1230 1231	if ( ! isset( $term->$field ) ) {1232		return '';1233	}1234 1235	return sanitize_term_field( $field, $term->$field, $term->term_id, $term->taxonomy, $context );1236}

Changelog

Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/taxonomy.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.