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

タナビーの高梨です。

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

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

今回は外部ブログカードのサムネイル画像を変更できるフィルターフック
👉get_external_blogcard_thumbnail_url
です

フックの概要

発火条件

外部ブログカード描画時に、無条件に１回発火します。

使いどころ

外部ブログカードで表示されるサムネイル画像できます。

具体的には以下のような活用が考えられます。

・サムネイル画像を独自の画像に置き換える
・特定のサイトやドメインの場合にサムネイルを強制的に差し替える

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

$image = apply_filters('get_external_blogcard_thumbnail_url', $image);

引数

$image：（string)サムネイルのURL

カスタマイズコード例

固定の画像を強制的にサムネイルとして表示させる例です。

function customize_get_external_blogcard_thumbnail_url ( $image ) {

    return 'https://hogehoge/hoge.jpg';

}
add_filter('get_external_blogcard_thumbnail_url', 'customize_get_external_blogcard_thumbnail_url');

注意点

・このフックはすべての外部ブログカードに対して発火します。条件分岐をしないと全て同じ画像に差し替えられるので注意してください。

・サイトごとに個別対応したい場合は、$image やURL情報を使って条件分岐を追加しましょう。

まとめ

・get_external_blogcard_thumbnail_url は外部ブログカードのサムネイル画像を差し替えるためのフィルターフック。

・無条件で発火するため、フォールバック画像の設定や独自カスタマイズに便利。

・利用時は条件分岐を入れ、意図しない一括置き換えに注意。