category_description

Filters the category description for display.

Description

apply_filters( 'category_description', (string) $category_description, (object) $category ); 

Parameters (2)

0. $category_description (string)
The category description.
1. $category (object)
Category object.

Usage

To run the hook, copy the example below.
  1. $category_description = apply_filters( 'category_description', $category_description, $category ); 
  2.  
  3. if ( !empty( $category_description ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the category_description callback 
  2. function filter_category_description( $category_description, $category ) { 
  3. // make filter magic happen here... 
  4. return $category_description
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'category_description', 'filter_category_description', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'category_description', 'filter_category_description', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/class-walker-category.php  
  1. $link .= 'title="' . esc_attr( strip_tags( apply_filters( 'category_description', $category->description, $category ) ) ) . '"';