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

タナビーの高梨です。

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

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

今回は関連記事カードのブロックでサムネイルのサイズを変更できるフィルターフック
👉get_related_entry_card_thumbnail_size
です

フックの概要

発火条件

関連記事カード描画時に無条件に発火します。

使いどころ

・関連記事カードのサムネイルサイズを変更できます
・サイトデザインに合わせた「小さめの一覧」「大きめのカード表示」などを柔軟に作れます

引数

$thumbnail_size：（string）サムネイルサイズ名

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

return apply_filters('get_related_entry_card_thumbnail_size', $thumbnail_size);

カスタマイズコード例

add_image_size('related_thumb', 320, 168, true);
add_filter('get_related_entry_card_thumbnail_size', function (){
  return 'related_thumb';
});
// 公式HPより引用（https://wp-cocoon.com/thumbnail-size-custom/)

注意点

・使用するサイズは事前に add_image_size() で登録しておく必要があります

・新しいサイズを反映させるには サムネイルの再生成 が必要になる場合があります

まとめ

・get_related_entry_card_thumbnail_sizeは、関連記事カードのブロックでサムネイルのサイズを制御できる便利なフック

・サイトデザインに応じた柔軟な調整に活用できる