Changeset 50505 for trunk/src/wp-login.php

Timestamp:

03/07/2021 12:30:38 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Add examples of possible names for various hooks whose name contains a dynamic portion.

This provides greater discoverability of such hooks in search results on the Code Reference site as well as increased clarity when reading the source.

See #50734, #52628

File:

• trunk/src/wp-login.php (modified) (1 diff)

trunk/src/wp-login.php

@@ -431 +431 @@
  *
  * The dynamic portion of the hook name, `$action`, refers to the action
- * that brought the visitor to the login form. Actions include 'postpass',
- * 'logout', 'lostpassword', etc.
+ * that brought the visitor to the login form.
+ *
+ * Possible hook names include:
+ *
+ *  - 'login_form_checkemail'
+ *  - 'login_form_confirm_admin_email'
+ *  - 'login_form_confirmaction'
+ *  - 'login_form_entered_recovery_mode'
+ *  - 'login_form_login'
+ *  - 'login_form_logout'
+ *  - 'login_form_lostpassword'
+ *  - 'login_form_postpass'
+ *  - 'login_form_register'
+ *  - 'login_form_resetpass'
+ *  - 'login_form_retrievepassword'
+ *  - 'login_form_rp'
  *
  * @since 2.8.0