Passwords: Deprecate second parameter of wp_new_user_notification().

The second parameter `$plaintext_pass` was removed in [33023] and restored as `$notify` in [33620] with a different behavior. If you have a plugin overriding `wp_new_user_notification()` which hasn't been updated you would get a notification with your username and the password "both".
To prevent this the second parameter is now deprecated and reintroduced as the third parameter.

Adds unit tests.

Props kraftbj, adamsilverstein, welcher, ocean90.
Fixes #33654.

(Don't ask for new pluggables kthxbye)

git-svn-id: https://develop.svn.wordpress.org/trunk@34116 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Dominik Schilling (ocean90)
2015-09-14 12:42:34 +00:00
parent 217c84e613
commit 08098026ce
7 changed files with 98 additions and 10 deletions

View File

@@ -679,4 +679,86 @@ class Tests_User extends WP_UnitTestCase {
$this->assertEquals( $user->user_email, 'test2@test.com' );
}
/**
* Testing wp_new_user_notification email statuses.
*
* @dataProvider data_wp_new_user_notifications
* @ticket 33654
*/
function test_wp_new_user_notification( $notify, $admin_email_sent_expected, $user_email_sent_expected ) {
unset( $GLOBALS['phpmailer']->mock_sent );
$was_admin_email_sent = false;
$was_user_email_sent = false;
$user = $this->factory->user->create( $this->user_data );
wp_new_user_notification( $user, null, $notify );
/*
* Check to see if a notification email was sent to the
* post author `blackburn@battlefield3.com` and and site admin `admin@example.org`.
*/
if ( ! empty( $GLOBALS['phpmailer']->mock_sent ) ) {
$was_admin_email_sent = ( isset( $GLOBALS['phpmailer']->mock_sent[0] ) && WP_TESTS_EMAIL == $GLOBALS['phpmailer']->mock_sent[0]['to'][0][0] );
$was_user_email_sent = ( isset( $GLOBALS['phpmailer']->mock_sent[1] ) && 'blackburn@battlefield3.com' == $GLOBALS['phpmailer']->mock_sent[1]['to'][0][0] );
}
$this->assertSame( $admin_email_sent_expected, $was_admin_email_sent, 'Admin email result was not as expected in test_wp_new_user_notification' );
$this->assertSame( $user_email_sent_expected , $was_user_email_sent, 'User email result was not as expected in test_wp_new_user_notification' );
}
/**
* Data provider for test_wp_new_user_notification().
*
* Passes the three available options for the $notify parameter and the expected email
* emails sent status as a bool.
*
* @return array {
* @type array {
* @type string $post_args The arguments that will merged with the $_POST array.
* @type bool $admin_email_sent_expected The expected result of whether an email was sent to the admin.
* @type bool $user_email_sent_expected The expected result of whether an email was sent to the user.
* }
* }
*/
function data_wp_new_user_notifications() {
return array(
array(
'',
true,
false,
),
array(
'admin',
true,
false,
),
array(
'both',
true,
true,
),
);
}
/**
* Set up a user and try sending a notification using the old, deprecated
* function signature `wp_new_user_notification( $user, 'plaintext_password' );`.
*
* @ticket 33654
* @expectedDeprecated wp_new_user_notification
*/
function test_wp_new_user_notification_old_signature_throws_deprecated_warning() {
$user = $this->factory->user->create(
array(
'role' => 'author',
'user_login' => 'test_wp_new_user_notification',
'user_pass' => 'password',
'user_email' => 'test@test.com',
)
);
wp_new_user_notification( $user, 'this_is_deprecated' );
}
}