Docs: Docblocks consistency fixes after [52604].

Follow-up to [52604].

Fixes #54690.


git-svn-id: https://develop.svn.wordpress.org/trunk@52605 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jb Audras
2022-01-19 12:40:57 +00:00
parent f53f2960f8
commit 2db35e5674
2 changed files with 12 additions and 4 deletions

View File

@@ -2939,11 +2939,11 @@ function retrieve_password( $user_login = null ) {
}
/**
* 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 ) ) {
return true;
@@ -3039,7 +3039,7 @@ function retrieve_password( $user_login = null ) {
$data = compact( 'key', 'user_login', 'user_data' );
/**
* 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
*

View File

@@ -9,8 +9,9 @@
/**
* Test retrieve_password(), in wp-includes/user.php.
*
* @group user
* @since 6.0.0
*
* @group user
* @covers ::retrieve_password
*/
class Tests_User_RetrievePassword extends WP_UnitTestCase {
@@ -23,6 +24,11 @@ class Tests_User_RetrievePassword extends WP_UnitTestCase {
*/
protected $user;
/**
* Create users for tests.
*
* @since 6.0.0
*/
public function set_up() {
parent::set_up();
@@ -36,6 +42,7 @@ class Tests_User_RetrievePassword extends WP_UnitTestCase {
}
/**
* The function should error when the email was not sent.
* @ticket 54690
*/
public function test_retrieve_password_reset_notification_email() {
@@ -44,6 +51,7 @@ class Tests_User_RetrievePassword extends WP_UnitTestCase {
}
/**
* The function should error when the email was not sent.
* @ticket 54690
*/
public function test_retrieve_password_should_return_wp_error_on_failed_email() {