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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

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

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

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。