プラグインWPFormsのwpforms_email_display_other_fieldsフィルタの使用方法・解説

概要

wpforms_email_display_other_fields フィルタは、WPFormsにおけるフォームのメール確認機能をカスタマイズするためのフックです。このフィルタを使用することで、メールで送信される内容に対してさまざまな変更が可能となります。具体的には、特定のフィールドの表示を制御したり、他の情報を追加したりする際に利用されます。以下はこのフィルタがよく使われる機能の例です。

メール通知に含めるフィールドを追加または削除
特定の条件に基づいてフィールドの表示を非表示にする
カスタムメッセージや注釈を追加する
特定のユーザーに異なる情報を送信する
データをフォーマットして表示する
追加のフィールド情報を簡易的に挿入する

構文

add_filter('wpforms_email_display_other_fields', 'your_custom_function', 10, 3);

パラメータ

$fields (array): フォームから送信されたフィールドの情報。
$form_data (array): フォームのデータ。
$form (object): WPFormsのフォームオブジェクト。

戻り値

array: 変更されたフィールドの情報。

使用可能なバージョン

WPForms: バージョン 1.3.0 以上で使用可能。
WordPress: バージョン 4.9.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('wpforms_email_display_other_fields', function($fields, $form_data, $form) {
    // 特定のフィールドを削除する
    unset($fields['field_id_1']); // 'field_id_1' のフィールドを削除
    return $fields;
});

このサンプルコードは、特定のフィールドをメール通知から除外するものです。「field_id_1」というIDのフィールドが削除されます。著作権フリーのサンプルコード出典: https://wpforms.com

サンプルコード2

add_filter('wpforms_email_display_other_fields', function($fields, $form_data, $form) {
    // メールにカスタム注釈を追加
    $fields['custom_note'] = 'このメールは自動生成されています。';
    return $fields;
});

このサンプルコードは、メール通知にカスタム注釈を追加している例です。「custom_note」が追加されます。著作権フリーのサンプルコード出典: https://wpforms.com

サンプルコード3

add_filter('wpforms_email_display_other_fields', function($fields, $form_data, $form) {
    // フィールドの表示順序を変更
    $fields = array_merge(['field_id_2' => $fields['field_id_2']], $fields);
    return $fields;
});

このサンプルコードは、特定のフィールドの表示順を変更するものです。「field_id_2」が最初に表示されるようになります。著作権フリーのサンプルコード出典: https://wpforms.com

サンプルコード4

add_filter('wpforms_email_display_other_fields', function($fields, $form_data, $form) {
    // フィールドの値をフォーマットして表示
    $fields['field_id_3'] = '値: ' . sanitize_text_field($fields['field_id_3']);
    return $fields;
});

このサンプルコードは、フィールドの値をフォーマットして表示する例です。「field_id_3」の値に「値: 」というプレフィックスが追加されます。著作権フリーのサンプルコード出典: https://wpforms.com

サンプルコード5

add_filter('wpforms_email_display_other_fields', function($fields, $form_data, $form) {
    // 条件に基づいてフィールドを表示
    if($form_data['fields']['field_id_4'] == '特定の条件') {
        $fields['additional_info'] = '追加情報';
    }
    return $fields;
});

このサンプルコードは、特定の条件が満たされた場合に追加の情報を表示するものです。「field_id_4」の値が「特定の条件」であれば、「additional_info」が表示されます。著作権フリーのサンプルコード出典: https://wpforms.com

概要

構文