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

Timestamp:

12/09/2019 01:08:53 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct DocBlock formatting for admin_email_confirm and admin_email_confirm_form hooks.

See #48303.

File:

• trunk/src/wp-login.php (modified) (3 diffs)

trunk/src/wp-login.php

@@ -603 +603 @@
                         /**
                          * Filters the interval for redirecting the user to the admin email confirmation screen.
+                         *
                          * If `0` (zero) is returned, the user will not be redirected.
                          *
                          * @since 5.3.0
                          *
-                         * @param int $interval Interval time (in seconds).
+                         * @param int $interval Interval time (in seconds). Default is 6 months.
                          */
                         $admin_email_check_interval = (int) apply_filters( 'admin_email_check_interval', 6 * MONTH_IN_SECONDS );
@@ -622 +623 @@
 
                 /**
-                * Fires before the admin email confirm form.
-                *
-                * @since 5.3.0
-                *
-                * @param WP_Error $errors A `WP_Error` object containing any errors generated by using invalid credentials. Note that the error object may not contain any errors.
-                */
+                 * Fires before the admin email confirm form.
+                 *
+                 * @since 5.3.0
+                 *
+                 * @param WP_Error $errors A `WP_Error` object containing any errors generated by using invalid
+                 *                         credentials. Note that the error object may not contain any errors.
+                 */
                 do_action( 'admin_email_confirm', $errors );
 
@@ -635 +637 @@
                         <?php
                         /**
-                        * Fires inside the admin-email-confirm-form form tags, before the hidden fields.
-                        *
-                        * @since 5.3.0
-                        */
+                         * Fires inside the admin-email-confirm-form form tags, before the hidden fields.
+                         *
+                         * @since 5.3.0
+                         */
                         do_action( 'admin_email_confirm_form' );