term_description( int $term, null $deprecated = null ): string
Retrieves term description.
Contents
Parameters
-
$termint Optional -
Term ID. Defaults to the current term ID.
-
$deprecatednull Optional -
Deprecated. Not used.
Default:
null
Return
string Term description, if available.
More Information
First available with WordPress Version 2.8, this template tag returns the description of a given term. A term ID and taxonomy are as parameters. If no term ID is passed, the description of current queried term (e.g. post category or tag) will be returned.
Output is wrapped in <p> tags.
Source
File: wp-includes/category-template.php.
View all references
function term_description( $term = 0, $deprecated = null ) {
if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
$term = get_queried_object();
if ( $term ) {
$term = $term->term_id;
}
}
$description = get_term_field( 'description', $term );
return is_wp_error( $description ) ? '' : $description;
}
Changelog
| Version | Description |
|---|---|
| 4.9.2 | The $taxonomy parameter was deprecated. |
| 2.8.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Displays a description of the post tag ID 28.
If you want to filter the description, don’t use this function, use
get_the_archive_description()instead. This one doesapply_filtersbefore returning the description, and usesterm_description()internally to retrieve the description when is for a term.Top ↑
Feedback
Except that get_the_archive_description() does not accept a term_id and so can only be used in the loop of an archive page. — By Peter Hardy-vanDoorn —
The default usage returns the description of the current queried term.