WordPress action hook · part of WordPress core
retrieve_password_key
A WordPress core action that 44 plugins also fire themselves, running on 788K+ sites between them.
“This action is documented in wp-login.php”
How to use retrieve_password_key
It's an action: your callback runs at that point and receives 2 arguments. Nothing needs to be returned.
Add this to your theme's functions.php or a small custom plugin:
add_action( 'retrieve_password_key', function( $user_login, $key ) {
// Your code runs here.
}, 10, 2 );Argument names come from rtMedia for WordPress, BuddyPress and bbPress's source. Other plugins may pass different values: check the call in the plugin you're targeting below.
This hook is fired by WordPress core too. Official reference on developer.wordpress.org →
44 plugins that fire retrieve_password_key
Sorted by active installs. Each entry shows where the plugin calls the hook and what it passes.
-
Forminator Forms600,000+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )library/modules/custom-forms/front/front-user-registration.php:1088 -
Manage Notification E-mails100,000+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )modules/pluggable/pluggable-functions-1.5.php:308 -
Customize WordPress Emails and Alerts30,000+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )includes/overrides.php:94 -
New User Approve20,000+ installs
do_action( 'retrieve_password_key', $username, $key )includes/class-nua-email-template-tags.php:488 -
AJAX Auth10,000+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )pluggable.php:49 -
s2Member8,000+ installs
do_action( 'retrieve_password_key', $user->user_login, $user_activation_key )src/includes/classes/email-configs.inc.php:261 -
rtMedia for WordPress, BuddyPress and bbPress7,000+ installs
do_action( 'retrieve_password_key', $user_login, $key )app/main/controllers/api/RTMediaJsonApi.php:502 -
Disable New User Notification Emails4,000+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )inc/namespace.php:71 -
WPMobile.App3,000+ installs
do_action( 'retrieve_password_key', $user_login, $key )inc/functions/shortcodes.php:45 -
Sailthru for WordPress1,000+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )sailthru_mail.php:108 -
User Spam Remover1,000+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )user-spam-remover.php:946 -
Pie Register1,000+ installs
do_action( 'retrieve_password_key', $user_login, $key )forgot_password.php:125 -
JSON API User1,000+ installs
do_action( 'retrieve_password_key', $user_login, $key )controllers/User.php:348 -
DirectoryPress600+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )includes/email-functions.php:108 -
Simple:Press Forum300+ installs
do_action( 'retrieve_password_key', $user_login, $key )sp-startup/core/credentials/sp-new-user-email.php:49 -
Custom New User Email Template200+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )custom-new-user-template.php:140 -
Mailing Group Listserv100+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )mailing-group-module.php:910 -
WP Custom Emails100+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )includes/core/overrides.php:99 -
WP Frontend Profile100+ installs
do_action( 'retrieve_password_key', $user_login, $user_email, $key )inc/class-wpfep-login.php:603 -
Ultimate AJAX Login90+ installs
do_action( 'retrieve_password_key', $user_login, $key )lib/class-ual-widget.php:254 -
Wp Auth60+ installs
do_action( 'retrieve_password_key', $user_login, $key )wp-auth.php:373 -
SB Login60+ installs
do_action( 'retrieve_password_key', $user_login, $key )sb-login.php:400 -
Ajax BootModal Login40+ installs
do_action( 'retrieve_password_key', $user_login, $key )inc/authenticate.php:202 -
User Activation By Email10+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )user-activation-by-email.php:188 -
EM Custom Login10+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )emails.php:164 -
Stionic Users10+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )endpoints/class-stionic-users.php:150 -
LH Personalised Content10+ installs
do_action( 'retrieve_password_key', $user->user_login, $key )lh-personalised-content.php:21 -
Ajax Login By WPH10+ installs
do_action( 'retrieve_password_key', $user_login, $key )php/functions.php:205 -
RESTful JSON API10+ installs
do_action( 'retrieve_password_key', $user_login, $key )controllers/user.php:377 -
RSVPMaker for Toastmasters10+ installs
do_action( 'retrieve_password_key', $user['user_login'], $key )core.php:11376 -
CubeAccount Frontend Login10+ installs
do_action( 'retrieve_password_key', $user_login, $key )cubeacct_wplogin.php:157 -
Radin app10+ installs
do_action( 'retrieve_password_key', $user_login, $key )includes/API/Controller/ForgetPasswordControllerRadinapp.php:58 -
YaExam10+ installs
do_action( 'retrieve_password_key', $user_login, $key )includes/shortcodes/class-yaexam-shortcode-my-account.php:222 -
Custom User Registration Lite10+ installs
do_action( 'retrieve_password_key', $user_info->user_login, $key )userreg.class.php:138 -
Android and iOS App plugin for WooCommerce by WSD10+ installs
do_action( 'retrieve_password_key', $user_login, $key )controllers/User.php:280 -
Vootouch10+ installs
do_action( 'retrieve_password_key', $user_login, $key )vootouchservice/forgetpassword.php:90 -
iw profile10+ installs
do_action( 'retrieve_password_key', $user_login, $key )iw-profile.php:483 -
Front End Login Form10+ installs
do_action( 'retrieve_password_key', $user_login, $key )loginForm.php:88 -
FoodBoxBooker10+ installs
do_action( 'retrieve_password_key', $user_login, $key )helper/foodboxbooker-data.php:1233 -
Author: Francis Crossen (fcrossen)10+ installs
do_action( 'retrieve_password_key', $u->user_login, $hash )tina_mvc/pages/registration_controller.php:273 -
PeoplePressFewer than 10 installs
do_action( 'retrieve_password_key', $user->user_login, $key )src/modules/user/handlers/registration/class-pp-wp-registration-handler.php:136 -
LH Email RegistrationFewer than 10 installs
do_action( 'retrieve_password_key', $user->user_login, $key )includes/lh-personalised-content.php:145 -
Pay2PostFewer than 10 installs
do_action( 'retrieve_password_key', $user_login, $key )lib/framework/includes/views-login.php:307 -
XC Authentication PluginFewer than 10 installs
do_action( 'retrieve_password_key', $user_login, $key )wp-xc-login.php:202
Need a customisation built on this hook?
Tell us what you want to change and which plugin it's for. We'll write it, test it and send it back as a small plugin.