Add hook to wp_set_password

[tanner m]

In WordPress 4.4 an action was added for the password reset option, however, I am working on a Single Sign-On application and need to sync the password every time it is updated. Many plugins call wp_set_password directly, so I'd like to propose adding an action to the end of the function to catch all instances of password setting.

[tanner m]

Patch 1

[audrasjb]

Hello and thanks for the ticket!

Looks like a simple and relevant feature and it has a patch.
Let's move this for 6.2 consideration.

However, the patch should be updated to add a ​Docblock for this new action :)

[tanner m]

Thanks! I'll update with the Docblock

[audrasjb]

Thanks for this new patch @tanner-m!

Looks almost good :)

Sorry for nitpicking but we have two small things to address before committing this, to make sure it's compliant to WordPress Coding Standards:

• Add a period at the end of the short description
• Put the @since mention between the shortdesc and the parameters

Just like this:

/**
 * Fires after the password is set.
 *
 * @since 6.2.0
 *
 * @param string $password The plain text password just set.
 * @param mixed  $user_id  The ID of the user whose password was just reset.
 */     
do_action( 'wp_set_password', $password, $user_id );

[tanner m]

Thanks! I'll get the hang of it eventually. :P

Just updated the patch.

[tanner m]

Patch - V3

[audrasjb]

Alright, this new patch looks good to me, thanks!

Adding needs-dev-note workflow keyword to not forget to mention this change in a WP 6.2 Dev Note :)

[audrasjb]

I was wondering whether the action should be triggered before or after clean_user_cache() but your implementation (after) looks like the best option, since it's better to clean the cached data before allowing operations to plugin authors. They can always re-clean cached data in their function, depending on what they are doing with the hook.

👆 Perhaps something worth mentioning in the dev note?

[audrasjb]

In 55056:

Users: Add an action hook on wp_set_password().

This changeset introduces the wp_set_password action hook, triggered after a password is set for a given user. As several plugins are calling wp_set_password() directly, adding an action to the end of the function will help plugin authors to catch all instances of password setting.

Props tanner-m, audrasjb.
Fixes #57436.

[audrasjb]

Hmm. Reopening as it would be nice to add unit tests for this new hook.

https://core.trac.wordpress.org/ticket/57436

[SergeyBiryukov]

In 55057:

Docs: Correct the type of the $user_id parameter in wp_set_password action.

Follow-up to [6600], [55056].

See #57436.

[audrasjb]

PR3844 adds a unit test for this new hook.

By the way, @SergeyBiryukov thanks for the docblock fix!

Thanks for working on the test!

We should be able to test that the action works as expected by checking the call count via MockAction:

public function test_wp_set_password_action() {
	$action = new MockAction();

	add_action( 'wp_set_password', array( $action, 'action' ) );

	wp_set_password( 'A simple password', self::$user_id );

	$this->assertSame( 1, $action->get_call_count() );
}

This approach is used in other tests and seems simpler that writing a meta value 🙂

Thanks for working on the test!

We should be able to test that the action works as expected by checking the call count via MockAction:

public function test_wp_set_password_action() {
	$action = new MockAction();

	add_action( 'wp_set_password', array( $action, 'action' ) );

	wp_set_password( 'A simple password', self::$user_id );

	$this->assertSame( 1, $action->get_call_count() );
}

This approach is used in other tests and seems simpler that writing a meta value 🙂

Oh ok, thanks @SergeyBiryukov 👍

I need to keep myself more up to date on the functions that can be used. Do you have a starting point resource in mind to discover the functions that can be used within WP core tests?

[costdev]

This ticket was reviewed during the recent bug scrub. I've reviewed the PR and left a couple of small additions. Adding changes-requested to note the current status of the ticket and PR.

Additional props: @mukesh27

_This is an update of #3844 to change "Test" to "Tests" in the docblock and to add a @covers annotation_

Trac ticket: https://core.trac.wordpress.org/ticket/57436

[costdev]

I've submitted ​PR 4020 to make small adjustments to PR 3844.

@audrasjb Is this one ready for commit?

Additional props: @mukesh27

Closing in favor of ​https://github.com/WordPress/wordpress-develop/pull/4020

[audrasjb]

Thanks for the new PR!

[audrasjb]

In 55250:

Build/Test Tools: Add unit tests for wp_set_password hook.

Follow-up to [55056].

Props audrasjb, SergeyBiryukov, costdev.
Fixes #57436.

committed in https://core.trac.wordpress.org/changeset/55250