cocoonフック調査~appeal_area_before、appeal_area_after

タナビーの高梨です。

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

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

今回はアピールエリア表示前後に発火するアクションフック
appeal_area_beforeappeal_area_after
です。

フックの発火条件

まずそもそもこのフックが発火するには、cocoon設定のアピールエリアタブの中で、アピールエリアが表示される設定になっていないと発火しません。

使いどころ

本文全体である”appeal-in”のIDを持つ<div>に挟まれる形で割り込むアクションフックです。

表示上はアピールエリアのコンテンツ全体の左右を挟み込むような形になります。
スマホ表示でもflex-directionが横方向のままのようなので、調整しないといびつになります。

PCではこんな感じ。

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

/tmp/appeal.php

<div id="appeal-in" class="appeal-in wrap">

    <?php //アピールエリア冒頭
    do_action('appeal_area_before'); ?>

    <?php //テキストメッセージエリアを表示するか
    if (is_appeal_area_content_visible()): ?>

~~ 省略 ~~

    <?php endif; ?>

    <?php //アピールエリア末尾
    do_action('appeal_area_after'); ?>
    
  </div>

引数

なし

カスタマイズコード例

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

function customize_appeal_area_before() {
    
    echo '<div style="background:red;color:white">appeal_area_beforeはここに表示できる</div>';

}
add_action('appeal_area_before', 'customize_appeal_area_before' );

function customize_appeal_area_after() {
    
    echo '<div style="background:red;color:white">appeal_area_afterはここに表示できる</div>';

}
add_action('appeal_area_after', 'customize_appeal_area_after' );