category_description( int $category )

Retrieves category description.

Contents

Parameters Parameters

$category

(int) (Optional) Category ID. Defaults to the current category ID.

Top ↑

Return Return

(string) Category description, if available.

Top ↑

More Information More Information

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.

Top ↑

Source Source

File: wp-includes/category-template.php 

function category_description( $category = 0 ) {
	return term_description( $category );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/category-template.php: term_description()

Retrieves term description.

Top ↑

Changelog Changelog

Changelog
Version Description
1.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 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 —

    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.

  3. Skip to note 3 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 —

    With Category Title

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

    Result:

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

You must log in before being able to contribute a note or feedback.