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:

functions.php
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.

  1. Forminator Forms icon Forminator Forms600,000+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) library/modules/custom-forms/front/front-user-registration.php:1088
  2. Manage Notification E-mails icon Manage Notification E-mails100,000+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) modules/pluggable/pluggable-functions-1.5.php:308
  3. Customize WordPress Emails and Alerts icon Customize WordPress Emails and Alerts30,000+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) includes/overrides.php:94
  4. New User Approve icon New User Approve20,000+ installs do_action( 'retrieve_password_key', $username, $key ) includes/class-nua-email-template-tags.php:488
  5. AJAX Auth icon AJAX Auth10,000+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) pluggable.php:49
  6. s2Member icon s2Member8,000+ installs do_action( 'retrieve_password_key', $user->user_login, $user_activation_key ) src/includes/classes/email-configs.inc.php:261
  7. rtMedia for WordPress, BuddyPress and bbPress icon rtMedia for WordPress, BuddyPress and bbPress7,000+ installs do_action( 'retrieve_password_key', $user_login, $key ) app/main/controllers/api/RTMediaJsonApi.php:502
  8. Disable New User Notification Emails icon Disable New User Notification Emails4,000+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) inc/namespace.php:71
  9. WPMobile.App icon WPMobile.App3,000+ installs do_action( 'retrieve_password_key', $user_login, $key ) inc/functions/shortcodes.php:45
  10. Sailthru for WordPress icon Sailthru for WordPress1,000+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) sailthru_mail.php:108
  11. User Spam Remover icon User Spam Remover1,000+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) user-spam-remover.php:946
  12. Pie Register icon Pie Register1,000+ installs do_action( 'retrieve_password_key', $user_login, $key ) forgot_password.php:125
  13. JSON API User icon JSON API User1,000+ installs do_action( 'retrieve_password_key', $user_login, $key ) controllers/User.php:348
  14. DirectoryPress icon DirectoryPress600+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) includes/email-functions.php:108
  15. Simple:Press Forum icon Simple:Press Forum300+ installs do_action( 'retrieve_password_key', $user_login, $key ) sp-startup/core/credentials/sp-new-user-email.php:49
  16. Custom New User Email Template icon Custom New User Email Template200+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) custom-new-user-template.php:140
  17. Mailing Group Listserv icon Mailing Group Listserv100+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) mailing-group-module.php:910
  18. WP Custom Emails icon WP Custom Emails100+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) includes/core/overrides.php:99
  19. WP Frontend Profile icon WP Frontend Profile100+ installs do_action( 'retrieve_password_key', $user_login, $user_email, $key ) inc/class-wpfep-login.php:603
  20. Ultimate AJAX Login icon Ultimate AJAX Login90+ installs do_action( 'retrieve_password_key', $user_login, $key ) lib/class-ual-widget.php:254
  21. Wp Auth icon Wp Auth60+ installs do_action( 'retrieve_password_key', $user_login, $key ) wp-auth.php:373
  22. SB Login icon SB Login60+ installs do_action( 'retrieve_password_key', $user_login, $key ) sb-login.php:400
  23. Ajax BootModal Login icon Ajax BootModal Login40+ installs do_action( 'retrieve_password_key', $user_login, $key ) inc/authenticate.php:202
  24. User Activation By Email icon User Activation By Email10+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) user-activation-by-email.php:188
  25. EM Custom Login icon EM Custom Login10+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) emails.php:164
  26. Stionic Users icon Stionic Users10+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) endpoints/class-stionic-users.php:150
  27. LH Personalised Content icon LH Personalised Content10+ installs do_action( 'retrieve_password_key', $user->user_login, $key ) lh-personalised-content.php:21
  28. Ajax Login By WPH icon Ajax Login By WPH10+ installs do_action( 'retrieve_password_key', $user_login, $key ) php/functions.php:205
  29. RESTful JSON API icon RESTful JSON API10+ installs do_action( 'retrieve_password_key', $user_login, $key ) controllers/user.php:377
  30. RSVPMaker for Toastmasters icon RSVPMaker for Toastmasters10+ installs do_action( 'retrieve_password_key', $user['user_login'], $key ) core.php:11376
  31. CubeAccount Frontend Login icon CubeAccount Frontend Login10+ installs do_action( 'retrieve_password_key', $user_login, $key ) cubeacct_wplogin.php:157
  32. Radin app icon Radin app10+ installs do_action( 'retrieve_password_key', $user_login, $key ) includes/API/Controller/ForgetPasswordControllerRadinapp.php:58
  33. YaExam icon YaExam10+ installs do_action( 'retrieve_password_key', $user_login, $key ) includes/shortcodes/class-yaexam-shortcode-my-account.php:222
  34. Custom User Registration Lite icon Custom User Registration Lite10+ installs do_action( 'retrieve_password_key', $user_info->user_login, $key ) userreg.class.php:138
  35. Android and iOS App plugin for WooCommerce by WSD icon Android and iOS App plugin for WooCommerce by WSD10+ installs do_action( 'retrieve_password_key', $user_login, $key ) controllers/User.php:280
  36. Vootouch icon Vootouch10+ installs do_action( 'retrieve_password_key', $user_login, $key ) vootouchservice/forgetpassword.php:90
  37. iw profile icon iw profile10+ installs do_action( 'retrieve_password_key', $user_login, $key ) iw-profile.php:483
  38. Front End Login Form icon Front End Login Form10+ installs do_action( 'retrieve_password_key', $user_login, $key ) loginForm.php:88
  39. FoodBoxBooker icon FoodBoxBooker10+ installs do_action( 'retrieve_password_key', $user_login, $key ) helper/foodboxbooker-data.php:1233
  40. Author: Francis Crossen (fcrossen) icon Author: Francis Crossen (fcrossen)10+ installs do_action( 'retrieve_password_key', $u->user_login, $hash ) tina_mvc/pages/registration_controller.php:273
  41. PeoplePress icon 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
  42. LH Email Registration icon LH Email RegistrationFewer than 10 installs do_action( 'retrieve_password_key', $user->user_login, $key ) includes/lh-personalised-content.php:145
  43. Pay2Post icon Pay2PostFewer than 10 installs do_action( 'retrieve_password_key', $user_login, $key ) lib/framework/includes/views-login.php:307
  44. XC Authentication Plugin icon 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.