cocoonフック調査～the_category_tag_contentの使い方と活用例

タナビーの高梨です。

WordPressのテーマ「Cocoon」には、テーマ改変なしでデザインや動作を拡張できる豊富なアクション・フィルターフックが用意されています。

分かる範囲で内容を調査したのでブログにまとめていこうと思います。

今回はカテゴリーとタグのアーカイブページで表示される、カテゴリーまたはタグに設定した本文の内容を書き換えられるフィルターフック
👉the_category_tag_content
です

フックの概要

発火条件

アーカイブページ描画時に、無条件に１回発火します。

使いどころ

カテゴリーやタグのアーカイブページで表示される、管理画面から設定した本文を自由に加工できます。

例えば以下のような活用が考えられます。

・本文の前にラベルを追加する（例：「説明：」を付ける）
・本文を一律で定型文に書き換える
・本文に広告やお知らせの要素を差し込む

👉 ダッシュボードの「投稿 ＞ カテゴリー」や「投稿 ＞ タグ」で編集画面を開くと「本文」を入力する欄がありますが、その出力内容をこのフックで制御できます。

apply_filters呼び出し元のソースコード

$content = apply_filters( 'the_category_tag_content', $content );

$content = apply_filters( 'the_category_tag_content', $content );

引数

$content：（string）本文の内容（HTML）

カスタマイズコード例

強制的に先頭に「説明：」と表示させる例です。

function customize_the_category_tag_content ( $content ) {

    $content = '<p>説明：</p>' . $content;
    return $content;

}
add_filter('the_category_tag_content', 'customize_the_category_tag_content');

注意点

・このフックはカテゴリー、タグの両方に対して発火します。どちらか片方だけを対象としたい場合は、the_category_contentまたはthe_tag_contentを使用する必要があります。

・本文を空にしてしまうと、説明文が全く表示されなくなるので注意してください。

まとめ

・the_category_tag_content はカテゴリー・タグ両方の本文をまとめて加工できるフィルターフック

・定型文の付与や説明文の整形に便利

・片方だけ制御したいときは the_category_content や the_tag_content を利用する