ワードプレスのcategory_descriptionフィルタの使用方法・解説

概要

category_description フィルタは、WordPress のカテゴリーの説明文を取得する際に利用されます。このフィルタを使うことで、カテゴリー説明文に対するカスタマイズやフィルタリングが可能となります。具体的には次のような機能を実装する際に役立ちます。

1. カテゴリー説明に特定のHTMLタグを追加する
2. カテゴリーの説明文にカスタムテキストを追加する
3. 言語ごとに異なる説明文を表示する
4. 説明文を条件に応じて変更する
5. 特定のユーザーの役割に基づいて説明文をフィルタリングする
6. SEOの観点から説明文を最適化する
7. カテゴリーの説明文を翻訳する
8. 説明文のスタイルを動的に変更する

構文

add_filter('category_description', 'custom_category_description', 10, 2);

パラメータ

• string $description 現在のカテゴリー説明
• int $category_id カテゴリーのID

戻り値

フィルタ後のカテゴリーの説明文（string）

関連する関数

• category_description

このフィルタを使用可能なバージョン

WordPress 1.5.0以降

コアファイルのパス

wp-includes/category.php

サンプルコード

サンプルコード 1

add_filter('category_description', function($description, $category_id) {
    if ($category_id === 2) {
        return $description . ' - 特別な説明文';
    }
    return $description;
});

このコードは、IDが2のカテゴリーについて説明文の最後に特別なテキストを追加します。
引用元: https://developer.wordpress.org/reference/functions/add_filter/

サンプルコード 2

add_filter('category_description', function($description) {
    return strtoupper($description);
});

このコードは、取得したカテゴリーの説明文を大文字に変換します。
引用元: https://developer.wordpress.org/reference/functions/add_filter/

サンプルコード 3

add_filter('category_description', function($description, $category_id) {
    return '<strong>' . $description . '</strong>';
}, 10, 2);

このコードは、すべてのカテゴリー説明を太字で表示します。
引用元: https://developer.wordpress.org/reference/functions/add_filter/

サンプルコード 4

add_filter('category_description', function($description) {
    $description .= '<p>ここに追加の情報が入ります。</p>';
    return $description;
});

このコードは、カテゴリー説明文の末尾に追加の情報を挿入します。
引用元: https://developer.wordpress.org/reference/functions/add_filter/

サンプルコード 5

add_filter('category_description', function($description, $category_id) {
    if (is_user_logged_in()) {
        return $description . ' (ログイン中のユーザーに表示)';
    }
    return $description;
}, 10, 2);

このコードは、ログインしているユーザーの場合に特定のメッセージをカテゴリー説明文に追加します。
引用元: https://developer.wordpress.org/reference/functions/add_filter/

この関数のアクションでの使用可能性

アクション	使用例
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init	〇
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

非推奨または削除されたバージョン

特にこのフィルタが非推奨または削除されたバージョンはありません。