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



お勧め

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。

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

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

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。