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.
See also
Parameters
- $field
-
(string) (Required) Term field to fetch.
- $term
-
(int|WP_Term) (Required) Term ID or object.
- $taxonomy
-
(string) (Optional) Taxonomy Name.
Default value: ''
- $context
-
(string) (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 );
}
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. |