概要
wpforms_frontend_strings フィルタは、WordPressプラグインWPFormsにおけるフックであり、フロントエンドで使用される文字列を変更するために利用されます。このフィルタは、主に以下のような機能実装時に役立ちます。
- フォームエラーメッセージのカスタマイズ
- ボタンラベルの翻訳や変更
- ユーザーガイドやヒントテキストの更新
- スタイルやデザインに合わせた用語変更
- アラートメッセージの国際化
- 他のプラグインとの互換性を保つ名称変更
構文
add_filter( 'wpforms_frontend_strings', 'your_function_name' );
パラメータ
$strings(array): WPFormsで使用される文字列の配列。
戻り値
- (array): 変更された文字列の配列。
使用可能なプラグインWPFormsのバージョン
- WPForms 1.4.0 以降
使用可能なWordPressのバージョン
- WordPress 4.9 以降
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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_frontend_strings', function( $strings ) {
$strings['error_required'] = 'このフィールドは必須です。';
return $strings;
});
説明: このコードは、WPFormsの必須フィールドのエラーメッセージをカスタマイズしています。デフォルトのメッセージを「このフィールドは必須です。」に変更します。
サンプル2: ボタンに表示されるテキストを変更
add_filter( 'wpforms_frontend_strings', function( $strings ) {
$strings['btn_submit'] = '送信する';
return $strings;
});
説明: この例では、送信ボタンに表示されるテキストを「送信する」に変更しています。
サンプル3: フォームのヒントテキストを更新
add_filter( 'wpforms_frontend_strings', function( $strings ) {
$strings['hint_enter_email'] = 'メールアドレスを入力してください';
return $strings;
});
説明: このコードは、メールアドレス入力フィールドに対するヒントテキストを変更しています。
サンプル4: 成功メッセージの翻訳
add_filter( 'wpforms_frontend_strings', function( $strings ) {
$strings['success'] = 'フォームが正常に送信されました！';
return $strings;
});
説明: フォーム送信成功時のメッセージをカスタマイズして、ユーザーに「フォームが正常に送信されました！」と伝えます。
サンプル5: カスタムアラートメッセージの追加
add_filter( 'wpforms_frontend_strings', function( $strings ) {
$strings['alert_custom'] = '注意：必要事項をすべて記入してください。';
return $strings;
});
説明: ユーザーに対して、必要事項をすべて記入するよう促すカスタムアラートメッセージを追加しています。