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

タナビーの高梨です。

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

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

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

フックの概要

発火条件

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

使いどころ

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

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

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

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

カテゴリーとタグのアーカイブページで表示される本文を同時に制御したい場合は、以下のフックを使うのもおすすめです。

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

the_category_tag_contentは、WordPressのテーマ「cocoon」で提供されているフック。使いどころ、使い方等調査しました。

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

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

引数

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

カスタマイズコード例

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

function customize_the_category_content ( $content ) {

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

}
add_filter('the_category_content', 'customize_the_category_content');

注意点

・このフックはカテゴリー専用です。タグの本文は変更されません

・タグ側を変更したい場合は the_tag_content を利用してください

・本文を空にすると説明文が表示されなくなるので、意図しない場合は必ず $content を返すようにしてください

まとめ

・the_category_content はカテゴリーアーカイブページの本文を加工できるフック

・説明文の前にラベルを付けたり、広告を差し込んだりできる

・タグや両方を制御したい場合は the_tag_content や the_category_tag_content を活用すると便利