プラグインThe Events Calendarのtec_events_allow_archive_block_templateフィルタの使用方法・解説

概要

tec_events_allow_archive_block_template フィルタは、WordPress の The Events Calendar プラグインにおいてアーカイブブロックのテンプレートを制御するためのフックです。このフィルタを使用することにより、特定の条件に基づいてアーカイブページの表示やテンプレートのカスタマイズが可能になります。具体的には、以下のような機能を実装する際によく活用されます。

アーカイブページのレイアウトを変更する際
特定のカテゴリーやタグに基づいてテンプレートを選択する際
ユーザーのロールによって異なる表示を行う際
特定の条件に応じてカスタムフィールドを表示する際
合計のイベント数に基づいて異なる情報を表示する際
テンプレートの条件を簡単に追加・変更する際

このフィルタは The Events Calendar プラグインのバージョン 5.0 以降、WordPress のバージョン 5.0 以降で使用可能です。

構文

add_filter('tec_events_allow_archive_block_template', 'your_custom_function', 10, 2);

パラメータ

$allow_archive (bool): デフォルトでアーカイブブロックを許可するかどうかのフラグ。
$post_type (string): 現在の投稿タイプ。

戻り値

bool: アーカイブブロックを許可する場合は true 、許可しない場合は false 。

この関数のアクションでの使用可能性

アクション	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

サンプルコード 1

add_filter('tec_events_allow_archive_block_template', function($allow_archive, $post_type) {
    if ($post_type === 'tribe_events') {
        // 'tribe_events' 投稿タイプであれば、アーカイブブロックを許可する
        return true;
    }
    return $allow_archive;
});

このコードは、tribe_events 投稿タイプのアーカイブブロックを常に許可するように設定しています。

サンプルコード 2

add_filter('tec_events_allow_archive_block_template', function($allow_archive, $post_type) {
    if (is_user_logged_in() && $post_type === 'tribe_events') {
        return true; // ログインユーザーに対してアーカイブを許可
    }
    return false; // その他は不許可
});

このコードは、ログインしたユーザーに対してのみ tribe_events のアーカイブブロックを許可します。

サンプルコード 3

add_filter('tec_events_allow_archive_block_template', function($allow_archive, $post_type) {
    if (get_option('disable_event_archive') === 'yes') {
        return false; // 設定オプションによってアーカイブを無効化
    }
    return $allow_archive;
});

このコードは、特定のオプションが有効になっている場合にアーカイブを無効にするものです。

サンプルコード 4

add_filter('tec_events_allow_archive_block_template', function($allow_archive, $post_type) {
    if (is_front_page() && $post_type === 'tribe_events') {
        return false; // フロントページではアーカイブを無効化
    }
    return $allow_archive;
});

このコードは、フロントページでは tribe_events のアーカイブブロックを無効にするよう設定します。

サンプルコード 5

add_filter('tec_events_allow_archive_block_template', function($allow_archive, $post_type) {
    // 特定のカスタムフィールドが設定されている場合にアーカイブを許可
    if (get_post_meta(get_the_ID(), 'allow_event_archive', true)) {
        return true;
    }
    return false;
});

このコードは、特定のカスタムフィールドが true に設定されている場合のみアーカイブブロックを許可します。

概要

構文