wp_get_password_hint()


関数wp_get_password_hint()は、WordPressのユーザー登録フォームやログインフォームで使用されるパスワードヒントのメッセージを取得するために使用されます。

構文

wp_get_password_hint();

この関数は、パスワードポリシーに基づくヒントを返します。例えば、「パスワードは少なくとも12文字である必要があります」などのメッセージを表示します。カスタムパスワードポリシーを設定した場合、このメッセージも適用されます。

例 1: パスワードヒントを表示する

以下のコードは、パスワードヒントをそのまま表示します。

<?php echo wp_get_password_hint(); ?>

例 2: カスタムメッセージの追加

デフォルトのヒントメッセージをカスタマイズして使用します。

<?php
$hint = wp_get_password_hint();
echo $hint . ' 強力なパスワードを設定してください。';
?>

例 3: 登録フォームにヒントを追加

以下のコードは、新規ユーザー登録フォームにパスワードヒントを表示します。

<?php
add_action( 'register_form', function() {
    echo '<p>' . wp_get_password_hint() . '</p>';
} );
?>

例 4: HTML要素に包んで表示

パスワードヒントを特定のHTML要素内に出力します。

<?php
echo '<div class="password-hint">' . wp_get_password_hint() . '</div>';
?>

例 5: フォームのカスタムバリデーション

以下のコードは、パスワードヒントを利用して入力のカスタムバリデーションを行います。

<?php
function custom_password_validation( $password ) {
    if ( strlen( $password ) < 12 ) {
        return wp_get_password_hint();
    }
    return true;
}
?>

注意点

  • wp_get_password_hint()はフィルタリングに対応しています。カスタムヒントを追加するにはpassword_hintフィルターを使用します。
  • この関数はHTMLを返す可能性があるため、XSS攻撃を防ぐためにエスケープ処理を適用してください。

関連機能：