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

概要

tag_descriptionフィルタは、投稿タグの説明文を取得する際に使用されるフィルタです。このフィルタを使用することで、デフォルトのタグの説明文を変更したり、カスタマイズすることができます。具体的には、次のような場合に活用されることが一般的です：

1. タグの説明文を動的に変更したい場合
2. SEO対策としてタグの説明文をカスタマイズする場合
3. 特定の条件に応じた説明文を表示する場合
4. タグの説明文にHTMLを追加したい場合
5. 複数言語対応のために説明文を変更したい場合
6. カスタムフィールドから説明文を取得する場合
7. テーマやプラグインによる統一感のために変更する場合
8. また、特定のユーザーの権限に基づいて説明を書き換える場合

このフィルタは、WordPressのコアファイルにおいてwp-includes/taxonomy.phpに記述されています。

構文

apply_filters('tag_description', $description, $tag);

パラメータ

• $description: 現在のタグの説明文。
• $tag: 現在のタグオブジェクト。

戻り値

フィルタを適用した後の説明文。

使用可能なバージョン

全てのWordPressバージョンで利用可能です。

関連する関数

関連する関数はこちら

コードサンプル

以下に、tag_descriptionフィルタを使ったサンプルコードを5つ示します。

1. タグの説明をカスタマイズする

add_filter('tag_description', 'custom_tag_description', 10, 2);

function custom_tag_description($description, $tag) {
    if ($tag->slug == 'my-tag') {
        return 'これはカスタムの説明です。';
    }
    return $description;
}

このコードは、特定のタグの説明文をカスタマイズします。

1. SEO要件に基づいて変更する

add_filter('tag_description', 'seo_tag_description', 10, 2);

function seo_tag_description($description, $tag) {
    if ($tag->slug == 'seo-tag') {
        return 'この説明はSEOのために特別に作成されました。';
    }
    return $description;
}

このコードは、SEO対策用の特別なタグ説明を設定します。

1. 複数言語対応の説明文を提供する

add_filter('tag_description', 'multi_language_tag_description', 10, 2);

function multi_language_tag_description($description, $tag) {
    $language = get_locale();
    if ($language == 'ja') {
        return '日本語の説明です。';
    }
    return $description;
}

このコードは、現在の言語設定に応じた説明を返します。

1. カスタムフィールドからの説明文の取得

add_filter('tag_description', 'custom_field_tag_description', 10, 2);

function custom_field_tag_description($description, $tag) {
    $custom_description = get_term_meta($tag->term_id, 'custom_description', true);
    if (!empty($custom_description)) {
        return $custom_description;
    }
    return $description;
}

このコードは、タグに関連付けられたカスタムフィールドから説明文を取得します。

1. 特定のユーザー権限に基づく説明文の変更

add_filter('tag_description', 'user_role_tag_description', 10, 2);

function user_role_tag_description($description, $tag) {
    if (current_user_can('administrator')) {
        return '管理者用の特別な説明。';
    }
    return $description;
}

このコードは、現在のユーザーの権限に応じた説明文を提供します。

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

アクション	使用可能性
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	〇

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

tag_descriptionフィルタは、特定のバージョンで非推奨又は削除されることはありませんでした。