プラグインThe Events Calendarのtec_custom_tables_v1_get_occurrence_match関数の使用方法・解説

概要

tec_custom_tables_v1_get_occurrence_match 関数は、WordPressのThe Events Calendarプラグインに含まれ、カスタムテーブルからイベントの出現をマッチさせるための汎用機能を提供します。この関数は、特定のイベントの時間や場所の検索操作を効率化する際に使用されます。また、データベースから特定の条件に基づいてレコードを取得するための柔軟性を提供します。

主に以下のような機能を実装する際によく使われます：
1. 特定のイベントのインスタンスを取得する。
2. フィルタ条件に基づいてイベントを絞り込む。
3. カスタムフィールドとの連携でイベントデータを取得する。
4. イベントの発生日時を判断するためのロジックを実装する。
5. ユーザーのタイムゾーンや現在の日付に基づいてイベントをフィルターする。
6. マップ情報を元に、地理間でのイベントを確認する。

構文

tec_custom_tables_v1_get_occurrence_match( $args );

パラメータ

$args (array): 必須。イベントの出現を検索するための引数を含む配列。

戻り値

成功した場合、マッチした出現の配列を返します。失敗した場合は null を返します。

バージョン情報

The Events Calendarプラグインのバージョン: 5.0以上
WordPressのバージョン: 5.0以上

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

アクション	使用可能性
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

$args = array(
    'event_id' => 123,
    'date'     => current_time( 'mysql' ),
);

$occurrences = tec_custom_tables_v1_get_occurrence_match( $args );

このコードは、指定されたイベント ID（123）の出現を現在の日付で検索します。

サンプルコード 2

$args = array(
    'event_id' => 456,
    'location' => 'Tokyo',
);

$event_at_tokyo = tec_custom_tables_v1_get_occurrence_match( $args );

このコードは、特定のイベント（ID 456）が東京で発生しているかどうかを確認するためのものです。

サンプルコード 3

$args = array(
    'event_id' => 789,
    'start'    => '2023-10-01',
    'end'      => '2023-10-31',
);

$october_events = tec_custom_tables_v1_get_occurrence_match( $args );

このコードは、指定されたイベント（ID 789）が2023年10月の期間内に発生するかどうかを問い合わせます。

サンプルコード 4

$args = array(
    'event_id' => 101112,
    'timezone' => 'Asia/Tokyo',
);

$event_in_timezone = tec_custom_tables_v1_get_occurrence_match( $args );

このコードは、特定のイベント（ID 101112）がアジア・東京のタイムゾーンや条件によってフィルタリングされた出現を求めます。

サンプルコード 5

$args = array(
    'event_id' => 131415,
    'user_id'  => get_current_user_id(),
);

$user_event = tec_custom_tables_v1_get_occurrence_match( $args );

このコードは、現在のユーザーによる特定のイベント（ID 131415）の出現をチェックするためのものです。

引用元のページはそれぞれ異なるため、具体的なURLは示せませんが、WordPressやThe Events Calendarの公式ドキュメントやフォーラムに情報が多く存在します。

概要

構文