get_term_field( string $field, int|WP_Term $term, string $taxonomy = '', string $context = 'display' ): string|int|null|WP_Error
- Since
- 2.3.0, 4.4.0
- Source
wp-includes/taxonomy.php:1221
Gets sanitized term field.
Description
The function is for contextual reasons and for simplicity of usage.
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
string|int|null|WP_Error- Will return an empty string if $term is not an object or if $field is not set in $term.
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
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 );}History
Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
4.4.0
The
$taxonomy parameter was made optional. $term can also now accept a WP_Term object.from the docblock2.3.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 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.