WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

term_description()

term_description( int $term, null $deprecated = null ): string

In this article

Back to top

Retrieves term description.

Parameters

$termintoptional
Term ID. Defaults to the current term ID.
$deprecatednulloptional
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

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;
}

View all references View on Trac View on GitHub

UsesDescription
is_tax()wp-includes/query.php

Determines whether the query is for an existing custom taxonomy archive page.

is_tag()wp-includes/query.php

Determines whether the query is for an existing tag archive page.

is_category()wp-includes/query.php

Determines whether the query is for an existing category archive page.

get_queried_object()wp-includes/query.php

Retrieves the currently queried object.

get_term_field()wp-includes/taxonomy.php

Gets sanitized term field.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 1 moreShow less
Used byDescription
get_the_archive_description()wp-includes/general-template.php

Retrieves the description for an author, post type, or term archive.

tag_description()wp-includes/category-template.php

Retrieves tag description.

category_description()wp-includes/category-template.php

Retrieves category description.

Changelog

VersionDescription
4.9.2The $taxonomy parameter was deprecated.
2.8.0Introduced.

User Contributed Notes

  1. Skip to note 4 content
    Elías
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

    If you want to filter the description, don’t use this function, use get_the_archive_description() instead. This one does apply_filters before returning the description, and uses term_description() internally to retrieve the description when is for a term.

You must log in before being able to contribute a note or feedback.