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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。