概要
woocommerce_lost_password_message
フィルタは、WooCommerceのパスワードリセット画面で表示されるメッセージを変更するために使用されます。このフィルタを利用することによって、デフォルトメッセージをカスタマイズしたり、特定の条件に基づいて異なるメッセージを表示したりすることができます。
よく使われる用途としては以下のようなものがあります。
1. パスワードリセット時のメッセージをブランドに合わせてカスタマイズ。
2. 特定のユーザーグループ向けの特別なメッセージを表示。
3. メッセージにカスタムHTMLを追加して視覚的なスタイルを強化。
4. メッセージ内にサポート情報やFAQへのリンクを追加。
5. ユーザーの行動を促すためのCall to Actionを追加。
6. 言語や地域によるメッセージの多言語対応。
構文
add_filter( 'woocommerce_lost_password_message', 'custom_lost_password_message' );
パラメータ
- $message: デフォルトの失ったパスワードメッセージ(文字列)。
戻り値
- フィルタリングされた新しいメッセージ(文字列)。
使用可能なバージョン
- WooCommerceのバージョン: 2.0 以降
- WordPressのバージョン: 4.0 以降
サンプルコード
サンプルコード1: デフォルトメッセージのカスタマイズ
add_filter( 'woocommerce_lost_password_message', 'custom_lost_password_message' );
function custom_lost_password_message( $message ) {
return 'お待たせしました!パスワードリセットのリンクがメールに送信されました。';
}
このサンプルは、パスワードリセットのメッセージをカスタマイズして、ビジネスに合わせた文言に変更します。
サンプルコード2: メッセージにHTMLタグを追加
add_filter( 'woocommerce_lost_password_message', 'html_lost_password_message' );
function html_lost_password_message( $message ) {
return '<strong>重要:</strong> リセットリンクは30分で有効期限が切れます。';
}
このサンプルは、メッセージ内にHTMLのタグを使って重要な情報を強調します。
サンプルコード3: 特定のユーザーに異なるメッセージを表示
add_filter( 'woocommerce_lost_password_message', 'specific_user_lost_password_message' );
function specific_user_lost_password_message( $message ) {
if ( is_user_logged_in() ) {
return 'ログインしている状態でリセットを行いました。';
}
return $message;
}
このコードは、すでにログインしているユーザーに特別なメッセージを表示します。
サンプルコード4: サポートリンクを追加
add_filter( 'woocommerce_lost_password_message', 'support_link_lost_password_message' );
function support_link_lost_password_message( $message ) {
return $message . ' もし問題が解決しない場合は、<a href="/support">こちらのサポートページ</a>をご覧ください。';
}
このサンプルは、メッセージの末尾にサポートページへのリンクを追加します。
サンプルコード5: 多言語サポートメッセージ
add_filter( 'woocommerce_lost_password_message', 'multilanguage_lost_password_message' );
function multilanguage_lost_password_message( $message ) {
if ( get_locale() == 'ja' ) {
return 'パスワードのリセットリンクをお送りしました。';
}
return 'A reset link has been sent to your email.';
}
このサンプルは、ユーザーの言語設定に応じて表示するメッセージを変更します。
この関数のアクションでの使用可能性
アクション | 使用可能性 |
---|---|
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 |