term_description( int $term, null $deprecated = null )
Retrieves term description.
Parameters
- $term
-
(int) (Optional) Term ID. Defaults to the current term ID.
- $deprecated
-
(null) (Optional) Deprecated. Not used.
Default value: 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
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. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/term_description