参数
- $term
-
(int)(可选) Term ID。默认为当前term ID。
- $deprecated
-
(null)(可选) 已弃用。不要使用。
默认值: null
返回
(string) 分类项描述(如有)。
说明
WordPress 2.8版首次提供此模板标签,它返回给定分类项(term)的描述。term ID和分类法(taxonomy)作为参数。如果没有传递term ID,则将返回当前查询term(如:post category或tag)的描述。
输出包装在 <p> 标签。
源码
更新日志
版本 | 描述 |
---|---|
4.9.2 | 废弃$taxonomy 参数。 |
2.8.0 | 开始引入 |
使用示例
显示文章标签ID 28的描述。
<?php echo 'Term Description: ' . term_description( '28','post_tag' ); ?>
如果要过滤描述,请不要使用此函数,而是使用
get_the_archive_description()
。这个函数在返回描述之前执行apply_filters
,并在内部使用term_description()
来检索描述。默认用法返回当前查询term的描述。
<?php $description = term_description(); ?>