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

概要

single_tag_title フィルタは、投稿タグ名を表示する際に利用されます。このフィルタを使うことで、タグの名称をカスタマイズしたり、アプリケーション内でタグ名に特定の処理を追加したりすることが可能です。以下のような場合に特に役立ちます。

1. タグ名にプレフィックスやサフィックスを追加したい
2. タグ名を特定のフォーマットに整形したい
3. 特定の条件に応じてタグ名を変更したい
4. タグ名を国際化（翻訳）したい
5. タグ名のデフォルトの動作を無効にしたい
6. タグ名にリンクを追加したい
7. タグ名の表示を特定のスタイルで変更したい
8. SEOの目的でタグ名を最適化したい

構文

add_filter('single_tag_title', 'custom_single_tag_title_function');

パラメータ

• $title (文字列)：現在のタグのタイトル。

戻り値

• フィルタ後のタグのタイトル（文字列）。

関連する関数

https://refwp.com/?titleonly=1&s=single_tag_title

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

WordPress 1.5 以降。

コアファイルのパス

wp-includes/query.php

サンプルコード

サンプル1: タグ名の前にカスタムテキストを追加

add_filter('single_tag_title', 'prefix_custom_tag_title');

function prefix_custom_tag_title($title) {
    return 'タグ: ' . $title;
}

このサンプルコードは、投稿タグ名の前に「タグ:」というテキストを追加します。

サンプル2: タグ名を大文字に変換

add_filter('single_tag_title', 'uppercase_tag_title');

function uppercase_tag_title($title) {
    return strtoupper($title);
}

このコードは、投稿タグ名をすべて大文字に変換します。

サンプル3: タグ名を特定の形式に整形

add_filter('single_tag_title', 'format_tag_title');

function format_tag_title($title) {
    return 'Customized Tag: [' . $title . ']';
}

こちらは、タグ名をカスタマイズされた形式で表示する例です。

サンプル4: タグ名を国際化する

add_filter('single_tag_title', 'translate_tag_title');

function translate_tag_title($title) {
    return __('Tag: ', 'your-text-domain') . $title;
}

このサンプルは、タグ名の前に翻訳可能なテキストを追加します。

サンプル5: タグ名を特定の条件で変更

add_filter('single_tag_title', 'conditional_tag_title');

function conditional_tag_title($title) {
    if (has_tag('special')) {
        return 'Special Tag: ' . $title;
    }
    return $title;
}

このコードでは、特定のタグ（この場合は「special」）が付けられているときだけ、タグ名を変更します。

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

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

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