Filter hook 'category_description'

in WP Core File wp-includes/class-walker-category.php at line 125

View Source

category_description

Filter Hook
Description
Filters the category description for display.

Hook Information

File Location wp-includes/class-walker-category.php View on GitHub
Hook Type Filter
Line Number 125

Hook Parameters

Type Name Description
string $description Category description.
WP_Term $category Category object.

Usage Examples

Basic Usage
<?php
// Hook into category_description
add_filter('category_description', 'my_custom_filter', 10, 2);

function my_custom_filter($description, $category) {
    // Your custom filtering logic here
    return $description;
}

Source Code Context

wp-includes/class-walker-category.php:125 - How this hook is used in WordPress core
<?php
 120  			 * @since 1.2.0
 121  			 *
 122  			 * @param string  $description Category description.
 123  			 * @param WP_Term $category    Category object.
 124  			 */
 125  			$atts['title'] = strip_tags( apply_filters( 'category_description', $category->description, $category ) );
 126  		}
 127  
 128  		/**
 129  		 * Filters the HTML attributes applied to a category list item's anchor element.
 130  		 *

PHP Documentation

<?php
/**
			 * Filters the category description for display.
			 *
			 * @since 1.2.0
			 *
			 * @param string  $description Category description.
			 * @param WP_Term $category    Category object.
			 */
Quick Info
  • Hook Type: Filter
  • Parameters: 2
  • File: wp-includes/class-walker-category.php
Related Hooks

Related hooks will be displayed here in future updates.