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

概要

フィルタ wpforms_pro_fields_entry_preview_get_field_value_show_empty は、WPForms プラグイン内で特定のフィールドの値を表示する際に空の値を処理するために使用されます。このフィルタを利用することで、空のフィールドの表示を制御し、よりカスタマイズされたフォームエントリーのプレビューを提供できます。具体的な用途としては、以下のようなシナリオで役立ちます。

空のフィールドを非表示にする
空のフィールドにデフォルトのテキストを表示する
特定の条件に基づいて空のフィールドを表示する
管理者向けのカスタムメッセージを設定する
特定のフィールドタイプに対してのみ動作させる
エントリーのプレビュー表示をカスタマイズする

構文

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

パラメータ

$value (string): フィールドの値。
$form_data (array): フォームのデータ。
$field_data (array): フィールドのデータ。

戻り値

フィルタ処理後のフィールドの値。

WPFormsのバージョン

プロ版が必要です。

ワードプレスのバージョン

4.0 以上。

サンプルコード

サンプルコード 1

add_filter( 'wpforms_pro_fields_entry_preview_get_field_value_show_empty', function( $value, $form_data, $field_data ) {
    return ! empty( $value ) ? $value : 'このフィールドは空です';
}, 10, 3 );

このコードは、フィールドが空の場合に「このフィールドは空です」というメッセージを表示します。

サンプルコード 2

add_filter( 'wpforms_pro_fields_entry_preview_get_field_value_show_empty', function( $value, $form_data, $field_data ) {
    return $field_data['type'] === 'email' && empty( $value ) ? 'メールアドレスが未入力です' : $value;
}, 10, 3 );

このコードは、フィールドがメールアドレスの場合、空の場合に特定のメッセージを表示します。

サンプルコード 3

add_filter( 'wpforms_pro_fields_entry_preview_get_field_value_show_empty', function( $value, $form_data, $field_data ) {
    return '指定のテキスト' === $value ? 'フィールドへの入力が求められています' : $value;
}, 10, 3 );

このコードは、指定のテキストが入力されている場合に特定のメッセージを表示します。

サンプルコード 4

add_filter( 'wpforms_pro_fields_entry_preview_get_field_value_show_empty', function( $value, $form_data, $field_data ) {
    if ( empty( $value ) && $field_data['required'] ) {
        return '必須フィールドです';
    }
    return $value;
}, 10, 3 );

このコードは、必須フィールドが空の場合に「必須フィールドです」とメッセージを表示します。

サンプルコード 5

add_filter( 'wpforms_pro_fields_entry_preview_get_field_value_show_empty', function( $value, $form_data, $field_data ) {
    return empty( $value ) ? sprintf( '<em>%s</em>', 'データなし' ) : $value;
}, 10, 3 );

このコードは、空のフィールドに「データなし」というメッセージを斜体で表示します。

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

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

概要

構文