get_password_reset_key

説明

string|WP_Error get_password_reset_key( WP_User $user )
パスワードリセットキーを取得する。

パラメータ

  • $user
    ユーザー情報を指定。

返り値

パラメータ$userがパスワードリセット可能な場合はパスワードリセットキーを返す。$userが無効かパスワードリセットキーをデータベースに保存できなかった場合はWP_Errorオブジェクトを返す。


注意

パスワードリセットキーはユーザーのパスワードをリセットする際のURLのパラメータとして使用される。

生成時間(秒)、':'、パスワードリセットキーのハッシュ値を連結したものは、ユーザー情報のプロパティ'user_activation_key'へ保存され、リセット実行時の検証で使用される。

[6.3.0] wp_is_password_reset_allowed_for_user関数が定義され、'allow_password_reset'フィルターは本関数から移動した。


使用例

  • パスワードリセットキーを取得する
    $key = get_password_reset_key( $user )

フィルター

[2.7.0]'retrieve_password'アクション後に'allow_password_reset'フィルターを呼び出す。パラメータ$allowにはリセット可能かどうかが、$user_IDには対象ユーザーのIDが格納されている。
$allow = apply_filters( 'allow_password_reset', $allow, $user_id );

アクション

[1.5.1]パラメータ$userがパスワードリセット可能か確認する前に'retrieve_password'アクションを呼び出す。パラメータ$user_loginには対象ユーザーのログイン名が格納されている。
do_action( 'retrieve_password', $user_login );
[2.5.0]パスワードリセットキーを生成した後に'retrieve_password_key'アクションを呼び出す。パラメータ$user_loginには対象ユーザーのログイン名が、$keyにはパスワードリセットキーが格納されている。
do_action( 'retrieve_password_key', $user_login, $key );

ソースファイル

/wp-includes/user.php

最終更新 : 2025年03月31日 10:22



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。