WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_set_password()

wp_set_password( string $password, int $user_id )

In this article

Back to top

Updates the user’s password with a new encrypted one.

Description

For integration with other applications, this function can be overwritten to instead use the other package password checking algorithm.

Please note: This function should be used sparingly and is really only meant for single-time application. Leveraging this improperly in a plugin or theme could result in an endless loop of password resets if precautions are not taken to ensure it does not execute on every page load.

Parameters

$passwordstringrequired
The plaintext new user password.
$user_idintrequired
User ID.

Source

function wp_set_password( $password, $user_id ) {
	global $wpdb;

	$hash = wp_hash_password( $password );
	$wpdb->update(
		$wpdb->users,
		array(
			'user_pass'           => $hash,
			'user_activation_key' => '',
		),
		array( 'ID' => $user_id )
	);

	clean_user_cache( $user_id );

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

View all references View on Trac View on GitHub

Hooks

do_action( ‘wp_set_password’, string $password, int $user_id )

Fires after the user password is set.

UsesDescription
wp_hash_password()wp-includes/pluggable.php

Creates a hash (encrypt) of a plain text password.

clean_user_cache()wp-includes/user.php

Cleans all user caches.

wpdb::update()wp-includes/class-wpdb.php

Updates a row in the table.

do_action()wp-includes/plugin.php

Calls the callback functions that have been added to an action hook.

Show 1 moreShow less
Used byDescription
wp_check_password()wp-includes/pluggable.php

Checks the plaintext password against the encrypted Password.

reset_password()wp-includes/user.php

Handles resetting the user’s password.

Changelog

VersionDescription
2.5.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    Below is an example showing how to update a user’s password

    <?php
$user_id = 1;
$password = 'HelloWorld';
wp_set_password( $password, $user_id );
?>

    Please note: This code should be deleted after ONE page load, otherwise the password will be reset on every subsequent load, sending the user back to the login screen each time.

You must log in before being able to contribute a note or feedback.