cocoonフック調査～is_widget_related_entry_card_category_label_visibleの使い方と活用例
タナビーの高梨です。
WordPressのテーマ「Cocoon」には、テーマ改変なしでデザインや動作を拡張できる豊富なアクション・フィルターフックが用意されています。
分かる範囲で内容を調査したのでブログにまとめていこうと思います。
今回は関連記事ウィジェットのカテゴリーラベル表示有無を制御できるフィルターフック
👉is_widget_related_entry_card_category_label_visible
です
フックの概要
| フック名 | 発火タイミング |
|---|---|
| is_widget_related_entry_card_category_label_visible | 関連記事ウィジェット表示時 |
発火条件
関連記事ウィジェットの表示タイミングで無条件に発火します
使いどころ
関連記事一覧のサムネイル上にカテゴリーラベルを表示させるかどうかを制御できます。
Cocoonのデフォルトでは、関連記事一覧のカテゴリーラベルは非表示になっています。
このフックを使うことで、簡単にカテゴリーを表示させるデザインに切り替えることが可能です。
活用例：
・関連記事一覧の視認性を高めたい
・記事ジャンルを一目で把握できるようにしたい
表示させた場合のイメージ（例）：
このように、カード型の関連記事サムネイルにカテゴリ名が重ねて表示されるようになります。
apply_filters呼び出し元のソースコード
lib/html-forms.php
$is_visible = apply_filters('is_widget_related_entry_card_category_label_visible', false);引数
$is_visible：（boolean）true：表示する、false：しない
カスタマイズコード例
上記で例記した一律に全てに対してラベルを表示する例です
add_filter('is_widget_related_entry_card_category_label_visible', '__return_true');
// 公式HPより引用（https://wp-cocoon.com/category-label-hooks/)注意点
・このフックは関連記事ウィジェット専用であり、関連記事カードなどには影響しません。
・値は単純なtrue / false なので、HTMLや文字列を返すとエラーになります。
・is_widget_entry_card_category_label_visibleのフックが優先されます。
is_widget_entry_card_category_label_visibleに関する記事
まとめ
・is_widget_related_entry_card_category_label_visible は、Cocoonテーマの関連記事ウィジェットにカテゴリラベルを表示させるかどうかを制御するためのシンプルなフィルターフックです。
・Cocoonの関連記事カードは標準でカテゴリ非表示ですが、このフックを活用すればワンラインで簡単に表示切替が可能。
カテゴリを明示したいメディアサイトやジャンル別ブログでは特に重宝します。
デザイン性と情報の分かりやすさを両立させたい場合に、ぜひ活用してみてください。