cocoonフック調査～tag_eye_catch_after

  • 投稿日
  • 著者 takanashi
  • カテゴリー cocoon
  • カテゴリー CODE
  • カテゴリー WordPress

タナビーの高梨です。

WordPressのテーマ「cocoon」では、豊富なアクションフックとフィルターフックが提供されています。

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

今回はタグアーカイブページの1ページ目に表示されるタグアイキャッチ画像の直後に発火するアクションフック
tag_eye_catch_after
です。

フックの発火条件

タグのアイキャッチが設定されていないと発火しません。
また、アーカイブの２ページ目以降はアイキャッチが表示されないので発火しません。

使いどころ

アイキャッチの直後に発火します。

この位置です。

タグの説明はタグ設定で指定できるので、ここに何を表示させたいのかはアイデアがありません。

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

/tmp/tag-content.php

    <?php if ($eye_catch_url):
      //アイキャッチがない場合は非表示クラスを追加
      $display_none = is_eyecatch_visible() ? null : ' display-none';
      //アイキャッチからキャプションを取得
      $caption = get_caption_from_image_url($eye_catch_url); ?>
      <div class="eye-catch-wrap<?php echo $display_none; ?>">
        <figure class="eye-catch">
          <img src="<?php echo esc_url($eye_catch_url); ?>" class="eye-catch-image wp-tag-image" alt="<?php echo esc_attr(get_the_tag_title($tag_id)); ?>">
          <?php //キャプション
          if (is_eyecatch_caption_visible() && $caption){
            echo '<figcaption class="eye-catch-caption">'.esc_html($caption).'</figcaption>';
          }; ?>
        </figure>
      </div>
      <?php do_action('tag_eye_catch_after'); ?>

引数

なし

カスタマイズコード例

上記画像での出力例です。

function customize_tag_eye_catch_after() {

    echo '<div style="background-color:red;color:white;">tag_eye_catch_afterはここに表示されます</div>';

}
add_action('tag_eye_catch_after', 'customize_tag_eye_catch_after' );