category_description
云策文档标注
概述
category_description 是一个 WordPress 过滤器,用于在显示分类描述时进行修改或增强。它允许开发者动态调整分类描述的内容,例如添加额外信息或格式化。
关键要点
- 过滤器名称:category_description
- 参数:$description(字符串,分类描述)和 $category(WP_Term 对象,分类对象)
- 用途:在输出分类描述前应用自定义逻辑,常用于前端显示优化
- 相关函数:在 Walker_Category::start_el() 中使用,位于 wp-includes/class-walker-category.php
- 版本历史:自 WordPress 1.2.0 引入
代码示例
add_action('category_description', 'category_description_28072021', 90, 2);
function category_description_28072021($description, $term){
if(is_admin()) return $description;
$term_id = isset($term->term_id) ? $term->term_id : $term;
$category = get_term($term_id);
$taxonomy = isset($category->taxonomy) ? $category->taxonomy : '';
$post_count = get_term_field('count', $term_id);
return sprintf(__('Total post Count: %s. ', 'textdomain'), $post_count). $description;
}注意事项
示例代码展示了如何通过过滤器添加文章计数到分类描述中,注意避免在后台(is_admin())应用修改,并正确处理 $term 参数。
原文内容
Filters the category description for display.
Parameters
$descriptionstring-
Category description.
$categoryWP_Term-
Category object.
Source
$atts['title'] = strip_tags( apply_filters( 'category_description', $category->description, $category ) );
Changelog
| Version | Description |
|---|---|
| 1.2.0 | Introduced. |
Skip to note 2 content
hasanrang05
Get access to term data and term field data
add_action('category_description', 'category_description_28072021', 90, 2); function category_description_28072021($description, $term){ if(is_admin()) return $description; //Get term data $term_id = isset($term->term_id) ? $term->term_id : $term; $category = get_term($term_id); $taxonomy = isset($category->taxonomy) ? $category->taxonomy : ''; // term field data $post_count = get_term_field('count', $term_id); return sprintf(__('Total post Count: %s. ', 'textdomain'), $post_count). $description; }