cocoonフック調査~is_widget_entry_card_category_label_visibleの使い方と活用例
タナビーの高梨です。
WordPressのテーマ「Cocoon」には、テーマ改変なしでデザインや動作を拡張できる豊富なアクション・フィルターフックが用意されています。
分かる範囲で内容を調査したのでブログにまとめていこうと思います。
今回は新着・人気・関連記事ウィジェットのカテゴリーラベル表示有無をまとめて制御できるフィルターフック
👉is_widget_entry_card_category_label_visible
です
フックの概要
| フック名 | 発火タイミング |
|---|---|
| is_widget_entry_card_category_label_visible | 新着・人気・関連それぞれの記事ウィジェット表示時 |
発火条件
新着・人気・関連それぞれの記事ウィジェットの表示タイミングで無条件に発火します
使いどころ
新着、人気、関連それぞれの記事一覧のサムネイル上にカテゴリーラベルを表示させるかどうかを制御できます。
Cocoonのデフォルトでは、新着、人気、関連記事一覧のカテゴリーラベルは非表示になっています。
このフックを使うことで、簡単にカテゴリーを表示させるデザインに切り替えることが可能です。
活用例:
・新着、人気、関連記事一覧の視認性を高めたい
・記事ジャンルを一目で把握できるようにしたい
apply_filters呼び出し元のソースコード
lib/html-forms.php
$is_visible = apply_filters('is_widget_entry_card_category_label_visible', $is_visible);
複数個所あり
引数
$is_visible:(boolean)true:表示する、false:しない
カスタマイズコード例
一律に全てに対してラベルを表示する例です
add_filter('is_widget_entry_card_category_label_visible', '__return_true');
// 公式HPより引用(https://wp-cocoon.com/category-label-hooks/)
注意点
・このフックは新着・人気・関連記事の3つのウィジェット全体に適用されます。個別に制御したい場合は、それぞれの専用フックを使用してください。
新着記事専用:is_new_entry_card_category_label_visible
人気記事専用:is_popular_entry_card_category_label_visible
関連記事専用:is_widget_related_entry_card_category_label_visible
・人気記事のサムネイルにはもともと順位(1、2、3、、、)が表示されているため、重ねて表示する形になります。
・値は単純なtrue / false なので、HTMLや文字列を返すとエラーになります。
まとめ
・is_widget_entry_card_category_label_visible は、新着・人気・関連記事ウィジェットのカテゴリラベル表示をまとめて制御できる便利なフィルターフックです。
・デフォルトで非表示のカテゴリラベルを簡単に一括表示でき、見た目やUXを整えるのに役立ちます。
・特にメディアサイトや複数ジャンルの記事を扱うブログでは、カテゴリ可視化による読者導線の強化に使えそうです。
デザインの統一やアクセシビリティ向上を図りたい場合に活用してみましょう。」