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

Parameters

$termintoptional

Term ID. Defaults to the current term ID.Default: 0

$deprecatedmixedoptional

Not used.Default: null

Return

string

Term description, if available.

Uses · 6

• is_tax()Determines whether the query is for an existing custom taxonomy archive page.
• is_tag()Determines whether the query is for an existing tag archive page.
• is_category()Determines whether the query is for an existing category archive page.
• get_queried_object()Retrieves the currently queried object.
• get_term_field()Gets sanitized term field.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Used by · 4

• category_description()Retrieves category description.
• get_the_archive_description()Retrieves the description for an author, post type, or term archive.
• render_block_core_term_description()Renders the `core/term-description` block on the server.
• tag_description()Retrieves tag description.

Source

View on Trac ↗View on GitHub ↗

1265function term_description( $term = 0, $deprecated = null ) {1266	if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {1267		$term = get_queried_object();1268		if ( $term ) {1269			$term = $term->term_id;1270		}1271	}1272 1273	$description = get_term_field( 'description', $term );1274 1275	return is_wp_error( $description ) ? '' : $description;1276}

History

Introduced in 2.8.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/category-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.