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



お勧め

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

Google Mapsブロックを作る過程で悩んだ件(2022年8月23日 更新)

自分なりのGoogle Mapsブロックを作るべく、カスタムHTMLブロックをベースにいくつかのパラメータ要素をサイドバーに追加していく。Google Maps用のAPIキーについてはオプションデータ(wp_optionsテーブル)に格納して利用していこうと思ったのだが、その方法がさっぱりわからなかった。

Popoverコンポーネントのanchorプロパティについて考えたときのメモ(2024年8月19日 更新)

カスタムブロックやコアブロック向けのプラグインでお世話になるPopoverコンポーネント。表示位置を決定する上で大きく影響するのがanchorプロパティである。フィルターのコールバック関数で対象ブロックに干渉できない場合はどうしたらよいのだろうか。