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

タナビーの高梨です。

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

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

今回は新着・人気・関連記事ウィジェットのサムネイル画像サイズをまとめて変更できるフィルターフック
👉get_widget_entries_thumbnail_size
です

フックの概要

発火条件

サイドバーなどウィジェットで新着記事、人気記事、関連記事のそれぞれのウィジェット描画時に１回発火します。

使いどころ

・サイドバーやフッターに表示されるウィジェットのサムネイルサイズを一括で統一できます
・サイトデザインに合わせた「小さめの一覧」「大きめのカード表示」などを柔軟に作れます

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

$thumb_size = apply_filters('get_new_entries_thumbnail_size', $thumb_size, $type);

引数

$thumbnail_size：（string）画像サイズ名
$type：（string）不明。サイドバーの場合、’default’という文字列が入っています

カスタマイズコード例

全てのサムネイルサイズを無条件に変更する例です。

add_image_size('widget_thumb', 120, 63, true);
add_filter('get_widget_entries_thumbnail_size', function (){
  return 'widget_thumb';
});
// 公式HPより引用（https://wp-cocoon.com/thumbnail-size-custom/)

注意点

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

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

・$type の値は環境や表示箇所によって異なる可能性があるため、デバッグして確認すると安心です

まとめ

・get_widget_entries_thumbnail_size は、新着・人気・関連記事ウィジェットのサムネイルサイズをまとめて制御できる便利なフック

・サイトデザインに応じた柔軟なサイドバー／フッターの調整に活用できる