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

概要

tec_events_custom_tables_v1_blocks_editor_event_meta フィルタは、WordPress プラグイン「The Events Calendar」を使用する際に、自分自身のイベントメタデータをブロックエディタで追加、変更、または削除するために使用されます。このフィルタは、開発者がイベントの表示や管理に柔軟性を持たせるために非常に役立ちます。よく使われる機能には次のようなものがあります。

カスタムフィールドの追加
イベント情報の表示を変更
メタボックスのカスタマイズ
イベントの日付や時刻のフォーマットを変更
イベントのカテゴリーやタグに関連する情報の表示
カスタムスタイルやスクリプトの追加

構文

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

パラメータ

$event_meta: 変更されるイベントメタデータの配列。
$event_id: 対象となるイベントの ID。

戻り値

変更されたイベントメタデータの配列。

使用可能なバージョン

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

add_filter( 'tec_events_custom_tables_v1_blocks_editor_event_meta', 'add_custom_event_meta', 10, 2 );

function add_custom_event_meta( $event_meta, $event_id ) {
    $event_meta['custom_field'] = get_post_meta( $event_id, '_custom_field', true );
    return $event_meta;
}

このサンプルコードは、カスタムフィールド「custom_field」をイベントメタデータに追加します。これにより、特定のイベントに関連する追加情報を表示できるようになります。

サンプルコード 2

add_filter( 'tec_events_custom_tables_v1_blocks_editor_event_meta', 'modify_event_date_format', 10, 2 );

function modify_event_date_format( $event_meta, $event_id ) {
    $event_date = get_post_meta( $event_id, '_EventStartDate', true );
    $event_meta['formatted_date'] = date( 'F j, Y', strtotime( $event_date ) );
    return $event_meta;
}

このコードは、イベントの日付を特定のフォーマット（例: “January 1, 2023″）で表示するようにカスタマイズします。

サンプルコード 3

add_filter( 'tec_events_custom_tables_v1_blocks_editor_event_meta', 'add_event_location', 10, 2 );

function add_event_location( $event_meta, $event_id ) {
    $location = get_post_meta( $event_id, '_EventVenueID', true );
    $event_meta['location'] = get_the_title( $location );
    return $event_meta;
}

このサンプルでは、イベントのロケーションを追加します。イベントに関連する会場名がメタデータとして含まれます。

サンプルコード 4

add_filter( 'tec_events_custom_tables_v1_blocks_editor_event_meta', 'customize_event_image', 10, 2 );

function customize_event_image( $event_meta, $event_id ) {
    $thumbnail_id = get_post_thumbnail_id( $event_id );
    $event_meta['thumbnail_url'] = wp_get_attachment_image_url( $thumbnail_id, 'full' );
    return $event_meta;
}

このコードは、イベントのサムネイル画像の URL をイベントメタデータに追加します。

サンプルコード 5

add_filter( 'tec_events_custom_tables_v1_blocks_editor_event_meta', 'add_event_tags', 10, 2 );

function add_event_tags( $event_meta, $event_id ) {
    $tags = get_the_terms( $event_id, 'post_tag' );
    if ( $tags && ! is_wp_error( $tags ) ) {
        $tag_names = wp_list_pluck( $tags, 'name' );
        $event_meta['tags'] = implode( ', ', $tag_names );
    }
    return $event_meta;
}

このサンプルコードは、イベントに関連するタグをメタデータに追加します。これにより、イベントに対する検索性が高まります。

概要

構文