Changeset 52605

Timestamp:

01/19/2022 12:40:57 PM (5 years ago)

Author:

audrasjb

Message:

Docs: Docblocks consistency fixes after [52604].

Follow-up to [52604].

Fixes #54690.

Location:

trunk

Files:

• src/wp-includes/user.php (modified) (2 diffs)
• tests/phpunit/tests/user/retrievePassword.php (modified) (4 diffs)

trunk/src/wp-includes/user.php

@@ -2940 +2940 @@
 
         /**
-         * Filter whether to send the retrieve password email.
+         * Filters whether to send the retrieve password email.
          *
          * @since 6.0.0
          *
-         * @param bool $send False to prevent sending. Default: true
+         * @param bool $send False to prevent sending. Default true.
          */
         if ( ! apply_filters( 'send_retrieve_password_email', true ) ) {
@@ -3040 +3040 @@
 
         /**
-         * Filter the contents of the reset password notification email sent to the user.
+         * Filters the contents of the reset password notification email sent to the user.
          *
          * @since 6.0.0

trunk/tests/phpunit/tests/user/retrievePassword.php

@@ -10 +10 @@
  * Test retrieve_password(), in wp-includes/user.php.
  *
+ * @since 6.0.0
+ *
  * @group user
- *
  * @covers ::retrieve_password
  */
@@ -24 +25 @@
         protected $user;
 
+        /**
+         * Create users for tests.
+         *
+         * @since 6.0.0
+         */
         public function set_up() {
                 parent::set_up();
@@ -37 +43 @@
 
         /**
+         * The function should error when the email was not sent.
          * @ticket 54690
          */
@@ -45 +52 @@
 
         /**
+         * The function should error when the email was not sent.
          * @ticket 54690
          */