get_term_field( string $field, int|WP_Term $term, string $taxonomy = '', string $context = 'display' ): string|int|null|WP_Error
Gets sanitized term field.
Contents
Description
The function is for contextual reasons and for simplicity of usage.
See also
Parameters
-
$fieldstring Required -
Term field to fetch.
-
$termint|WP_Term Required -
Term ID or object.
-
$taxonomystring Optional -
Taxonomy name.
Default:
'' -
$contextstring Optional -
How to sanitize term fields. Look at sanitize_term_field() for available options.
Default'display'.More Arguments from sanitize_term_field( ... $context )
Context in which to sanitize the term field.
Accepts'raw','edit','db','display','rss','attribute', or'js'. 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.
Source
File: wp-includes/taxonomy.php.
View all references
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 |
|---|---|
| 4.4.0 | The $taxonomy parameter was made optional. $term can also now accept a WP_Term object. |
| 2.3.0 | Introduced. |