概要
tec_events_custom_tables_v1_custom_tables_query_results フィルタは、The Events Calendar プラグインにおいて、カスタムテーブルからのイベントデータのクエリ結果をフィルタリングするためのフックです。このフィルタを使用することで、デフォルトのクエリ結果を変更し、独自のデータを追加したり、不要なデータを削除したりすることができます。主に以下のような機能を実装する際によく使われます。
- カスタムメタデータの追加
- 特定の条件に基づくイベントのフィルタリング
- データ形式の変更や再フォーマット
- 特定のイベントのみを抽出するカスタムロジック
- データのソート順の変更
- デフォルトのクエリと整合性のあるダイナミックなレスポンスの提供
構文
add_filter('tec_events_custom_tables_v1_custom_tables_query_results', 'custom_function_name', 10, 3);
パラメータ
$results: デフォルトのクエリ結果（配列）。$query_args: 元のクエリの引数（配列）。$this: The Events Calendar のクラスインスタンス。
戻り値
フィルタリングされたクエリ結果の配列。
使用可能なプラグインとバージョン
- The Events Calendar: バージョン 5.0 以上
- WordPress: バージョン 5.0 以上
サンプルコード
サンプルコード 1: 特定のカテゴリーのイベントのみを取得
このコードは特定のカテゴリーのイベントのみを抽出するフィルターを追加します。
add_filter('tec_events_custom_tables_v1_custom_tables_query_results', function($results, $query_args, $this) {
global $wpdb;
$category_id = 123; // ここに特定のカテゴリーIDを指定
$results = array_filter($results, function($event) use ($category_id) {
return in_array($category_id, $event['EventCategory']);
});
return $results;
});
引用元: https://theeventscalendar.com/
サンプルコード 2: イベントデータにカスタムフィールドを追加
このコードはクエリ結果にカスタムフィールドを追加するサンプルです。
add_filter('tec_events_custom_tables_v1_custom_tables_query_results', function($results, $query_args, $this) {
foreach ($results as &$event) {
$event['custom_field'] = get_post_meta($event['ID'], 'custom_field_key', true);
}
return $results;
});
引用元: https://theeventscalendar.com/
サンプルコード 3: イベントを降順でソート
このコードは、イベントを日付の降順でソートするためのフィルターです。
add_filter('tec_events_custom_tables_v1_custom_tables_query_results', function($results, $query_args, $this) {
usort($results, function($a, $b) {
return strtotime($b['StartDate']) - strtotime($a['StartDate']);
});
return $results;
});
引用元: https://theeventscalendar.com/
サンプルコード 4: 特定のフィールドを削除
このコードは、イベントデータから特定のフィールドを削除する例です。
add_filter('tec_events_custom_tables_v1_custom_tables_query_results', function($results, $query_args, $this) {
foreach ($results as &$event) {
unset($event['unnecessary_field']);
}
return $results;
});
引用元: https://theeventscalendar.com/
サンプルコード 5: 結果にスタイルを適用
このコードは、クエリ結果に特定のスタイルを適用する方法を示しています。
add_filter('tec_events_custom_tables_v1_custom_tables_query_results', function($results, $query_args, $this) {
foreach ($results as &$event) {
$event['styled_title'] = '<span class="event-title">' . esc_html($event['Title']) . '</span>';
}
return $results;
});
引用元: https://theeventscalendar.com/
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 |
この表は、フィルタがサポートされているアクションを示しています。使用されるアクションによって使い方が異なるため、適切なアクションと組み合わせて利用されることが多いです。