WordPress.org

Function Reference/category description

Languages: English • 日本語 • Português do Brasil • (Add your language)

Description

Returns the description of a category defined in the category settings screen for the current category (Posts > Categories).

If used in the archive.php template, place this function within the is_category() conditional statement. Otherwise, this function will stop the processing of the page for monthly and other archive pages.

Usage

<?php echo category_description( $category_id ); ?>

Parameters

$category_id

(integer) (optional) The ID of the category to return a description.

Default: Description of current query category.

Example

Default Usage

Displays the description of a category, given its id, by echoing the return value of the tag. If no category given and used on a category page, it returns the description of the current category.

<div><?php echo category_description(3); ?></div>

Result:

WordPress is a favorite blogging tool of mine and I share tips and tricks for using WordPress here.

Note: if there is no category description, the function returns a br tag.

Using Category Slug

Displays the description of a category, using a category slug.

<?php echo category_description( get_category_by_slug('category-slug')->term_id ); ?>

With Category Title

<div><strong><?php single_cat_title('Currently browsing'); ?> </strong>: <?php echo category_description(); ?></div>

Result:

Currently browsing WordPress: WordPress is a favorite blogging tool of mine and I share tips and tricks for using WordPress here.

Change Log

Since: 1.0.0

Notes

Uses: term_description()

Source File

category_description() is located in wp-includes/category-template.php.

Categories: the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category()

See also index of Function Reference and index of Template Tags.