プラグインThe Events Calendarのtec_events_elementor_loadedアクションの使用方法・解説

概要

tec_events_elementor_loadedアクションフックは、WordPressプラグイン「The Events Calendar」で使用され、Elementorによるイベント表示の際に特定の操作を行うためのフックです。このフックは、Elementorがイベントデータを表示する準備ができたタイミングでコールされるため、開発者は独自のカスタマイズや機能を追加することができます。以下は、tec_events_elementor_loadedアクションのよく使用される機能の例です。

イベントのカスタムフィールドを表示する。
スタイルやスクリプトを条件に応じて読み込む。
独自のウィジェットをElementorに追加する。
テンプレートをカスタマイズする。
特定のイベントデータをフィルタリングする。
関連するプラグインや機能との統合を行う。

構文

add_action('tec_events_elementor_loaded', 'your_custom_function_name');

パラメータ

tec_events_elementor_loadedアクションにはパラメータはありません。

戻り値

このアクションは特に戻り値を返しません。

使用可能なバージョン

The Events Calendarバージョン: 5.0以上
WordPressバージョン: 4.9以上

サンプルコード一覧

サンプルコード1

add_action('tec_events_elementor_loaded', function() {
    if ( class_exists( 'ElementorPlugin' ) ) {
        echo '<div class="custom-event-notice">イベントが読み込まれました！</div>';
    }
});

このコードは、Elementorがイベントを読み込んだときにカスタムメッセージを表示します。

サンプルコード2

add_action('tec_events_elementor_loaded', function() {
    wp_enqueue_style('custom-events-style', plugins_url('/css/custom-events.css', __FILE__));
});

このコードは、イベントが読み込まれる際にカスタムスタイルシートを読み込みます。

サンプルコード3

add_action('tec_events_elementor_loaded', function() {
    add_action('elementor/widget/render_content', function($content) {
        return $content . '<div class="footer-message">参加してくれてありがとうございます！</div>';
    });
});

このコードは、Elementorウィジェットのコンテンツがレンダリングされる際にフッターメッセージを追加します。

サンプルコード4

add_action('tec_events_elementor_loaded', function() {
    remove_action('elementor/widgets/widgets_registered', 'register_my_custom_widget');
});

このコードは、特定のカスタムウィジェットの登録をキャンセルします。Elementorがイベントを読み込む際に使われます。

サンプルコード5

add_action('tec_events_elementor_loaded', function($elementor) {
    // 特定の条件の下でウィジェットを非表示にする
    if (is_page('special-event')) {
        add_filter('elementor/widgets/should_render', function($should_render, $widget) {
            if ($widget->get_name() === 'my-custom-widget') {
                return false;
            }
            return $should_render;
        }, 10, 2);
    }
});

このコードは「special-event」ページが表示される際に、特定のウィジェットを非表示にします。

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

アクション名	使用例
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

概要

構文