Help us to improve the Codex by filling out our documentation survey!Function Reference/tag description
Languages: English • Türkçe • 日本語 • (Add your language)
Contents |
Description
First available with WordPress Version 2.8, this template tag returns the description of a tag. A tag ID can be passed as a parameter, but if no tag ID is passed, the description current queried tag will be returned.
Usage
<?php tag_description( $tag_id ); ?>
Default Usage
The default usage returns the description of the current queried tag.
<?php $description = tag_description(); ?>
Parameters
- $tag_id
- (integer) (optional) The ID of the tag to return a description.
- Default: Description of current query tag.
Return Values
- (string)
- Tag description, available.
Example
Displays a description of the tag id 28.
<?php echo 'Tag Description: ' . tag_description('28'); ?>
Change Log
- Since: 2.8.0
Notes
- Uses: term_description()
- Output is wrapped in <p> tags.
Source File
tag_description() is located in wp-includes/category-template.php.
Related
Tags: the_tags(), tag_description(), single_tag_title(), wp_tag_cloud(), wp_generate_tag_cloud(), get_tags(), get_the_tags(), get_the_tag_list(), get_tag_link()
See also index of Function Reference and index of Template Tags.
