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

タナビーの高梨です。

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

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

今回は新着・関連ウィジェット表示時に取得クエリに渡される$argsを変更できるフィルターフック
👉widget_entries_args
です

フックの概要

発火条件

新着・関連記事ウィジェットの表示タイミングで無条件に発火します

使いどころ

新着・関連記事一覧を取得する際の取得方法を制御することができます。

記事一覧は$query = new WP_Query( $args );で取得されます。

この$argを制御することができます。

$argの初期値は設定などの条件によって異なりますが、例えばこのようになっています。

array(10) {
    ["posts_per_page"]=> string(1) "5"
    ["no_found_rows"]=> bool(true)
    ["action"]=> NULL
    ["offset"]=> int(0)
    ["ignore_sticky_posts"]=> bool(true)
    ["order"]=> string(4) "DESC"
    ["orderby"]=> string(4)"rand"
    ["post__not_in"]=> array(1) { [0]=> int(108) }
    ["tax_query"]=> array(2) {
        [0]=> array(1) {
            [0]=> array(5) {
                ["taxonomy"]=> string(8) "category"
                ["terms"]=> array(1) {[0]=> int(4) }
                ["include_children"]=> int(0)
                ["field"]=> string(7) "term_id"
                ["operator"]=> string(2) "IN"
            }
        }
        ["relation"]=> string(3) "AND"
    }
    ["post_type"]=> array(1) { [0]=> string(4) "post" }
}

これらに対して、削除、追加、変更など自由に編集することができます。

活用例：

・取得の順番を変更したい
・ページによって取得条件を変更したい

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

  if ($random) {
    $args = apply_filters('widget_related_entries_args', $args);
    $thumb_size = apply_filters('get_related_entries_thumbnail_size', $thumb_size, $type);
  } else {
    $args = apply_filters('widget_new_entries_args', $args);
    $thumb_size = apply_filters('get_new_entries_thumbnail_size', $thumb_size, $type);
  }
  $args = apply_filters('widget_entries_args', $args);

引数

$args：（array）WP_Queryに渡す配列

カスタマイズコード例

新着、関連とも一律に取得する際のソート順を昇順にする例です。

function customize_widget_entries_args ( $args ) {

    $args['order'] = 'ASC';

    return $args;

}
add_filter('widget_entries_args', 'customize_widget_entries_args' );

注意点

・このフックは新着・関連記事の2つのウィジェットに同時に適用されます。個別に制御したい場合は、それぞれの専用フックを使用してください。

新着記事：widget_new_entries_args

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

widget_new_entries_argsは、WordPressのテーマ「cocoon」で提供されているフック。使いどころ、使い方等調査しました。

関連記事：widget_related_entries_args

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

widget_related_entries_argsは、WordPressのテーマ「cocoon」で提供されているフック。使いどころ、使い方等調査しました。

widget_entries_argsはwidget_new_entries_argsとwidget_related_entries_argsよりも優先されます。

それぞれ個別に制御したい場合は下記で紹介している個別のフックを利用してください。

・$argsの内容が不正になると関連記事が意図せず取得できなくなります

まとめ

・widget_entries_args は、新着・関連記事ウィジェットの取得条件を同時に柔軟に変更できるフィルターフックです。

並び順・件数・カテゴリ・投稿タイプなどを自由に変更できるため、サイト構成やデザインに合わせた関連記事表示を実現できます。

同様の仕組みを持つwidget_related_entries_argsやwidget_new_entries_argsもチェックしてみてください。