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

概要

woocommerce_lost_password_confirmation_message フィルタは、WooCommerce におけるパスワードリセットリクエスト後に表示される確認メッセージをカスタマイズする際に使用されます。このフィルタを利用することで、サイト運営者はユーザーエクスペリエンスを向上させたり、ブランドに合わせたメッセージを提供したりすることが可能です。

主な使用ケースは以下の通りです。
1. メッセージの内容を変更する。
2. 特定の条件に応じてメッセージをカスタマイズする。
3. メッセージのスタイルやフォーマットを変更する。
4. ユーザーに追加のリマインダーを表示する。
5. 他のプラグインのメッセージと統合する。
6. メッセージにカスタム HTML を追加する。

構文

add_filter( 'woocommerce_lost_password_confirmation_message', 'your_custom_function' );

パラメータ

• string $message: デフォルトの確認メッセージ。

戻り値

• string: カスタマイズされた確認メッセージ。

使用可能なプラグインバージョン

• WooCommerce: 3.0以降
• WordPress: 4.0以降

サンプルコード

1. メッセージをシンプルなものに変更する

   add_filter( 'woocommerce_lost_password_confirmation_message', 'custom_confirmation_message' );
   
   function custom_confirmation_message( $message ) {
      return 'パスワードリセットのリクエストを受け付けました。';
   }
   

   このサンプルコードは、デフォルトの確認メッセージを短くシンプルな文に変更します。

2. カスタム HTMLを含むメッセージを追加

   add_filter( 'woocommerce_lost_password_confirmation_message', 'custom_html_confirmation_message' );
   
   function custom_html_confirmation_message( $message ) {
      return '<strong>パスワードリセットリクエストが送信されました!</strong> メールボックスを確認してください。';
   }
   

   メッセージにHTMLタグ（太字）を追加し、視覚的に際立たせます。

3. ダイナミックなコンテンツを挿入

   add_filter( 'woocommerce_lost_password_confirmation_message', 'dynamic_confirmation_message' );
   
   function dynamic_confirmation_message( $message ) {
      $user_email = !empty($_POST['user_login']) ? sanitize_email($_POST['user_login']) : '';
      return 'パスワードリセットメールが ' . esc_html($user_email) . ' に送信されました。';
   }
   

   入力されたユーザーのメールアドレスを表示するメッセージを作成します。

4. 特定の条件に基づいて異なるメッセージを表示

   add_filter( 'woocommerce_lost_password_confirmation_message', 'conditional_confirmation_message' );
   
   function conditional_confirmation_message( $message ) {
      if ( is_user_logged_in() ) {
          return 'ログイン状態のため、パスワードリセットは必要ありません。';
      }
      return $message;
   }
   

   ユーザーがログインしている場合は異なるメッセージを表示します。

5. 特別なリマインダーを追加する

   add_filter( 'woocommerce_lost_password_confirmation_message', 'reminder_confirmation_message' );
   
   function reminder_confirmation_message( $message ) {
      return $message . ' また、スパムフォルダも確認してください。';
   }
   

   デフォルトメッセージの後に、スパムフォルダの確認を追加するリマインダーを付け加えます。

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