Question

term_description( int $term,  string $taxonomy = 'post_tag' )

Retrieve term description.

---

description

---

参数

$term

(int) (Optional) Term ID. Will use global term ID by default.

$taxonomy

(string) (Optional) taxonomy name. Defaults to 'post_tag'.

Default value: 'post_tag'

---

返回值

(string) Term description, available.

---

源代码

File: wp-includes/category-template.php

function term_description( $term = 0, $taxonomy = 'post_tag' ) {
	if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
		$term = get_queried_object();
		if ( $term ) {
			$taxonomy = $term->taxonomy;
			$term = $term->term_id;
		}
	}
	$description = get_term_field( 'description', $term, $taxonomy );
	return is_wp_error( $description ) ? '' : $description;
}

---

更新日志

Version	description
2.8.0	Introduced.

---

相关函数

Uses

• wp-includes/query.php: is_tax()
• wp-includes/query.php: is_tag()
• wp-includes/query.php: is_category()
• wp-includes/query.php: get_queried_object()
• wp-includes/taxonomy.php: get_term_field()
• wp-includes/load.php: is_wp_error()
Show 1 more use Hide more uses

---

Used By

• wp-includes/general-template.php: get_the_archive_description()
• wp-includes/category-template.php: tag_description()
• wp-includes/category-template.php: category_description()

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Codex

   The default usage returns the description of the current queried term.

   
   <?php $description = term_description(); ?>
   
   

Displays a description of the post tag ID 28.

<?php echo 'Term description: ' . term_description( '28','post_tag' ); ?>