WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_is_password_reset_allowed_for_user()

wp_is_password_reset_allowed_for_user( int|WP_User $user ): bool|WP_Error

In this article

Back to top

Checks if password reset is allowed for a specific user.

Parameters

$userint|WP_Userrequired
The user to check.

Return

bool|WP_Error True if allowed, false or WP_Error otherwise.

Source

function wp_is_password_reset_allowed_for_user( $user ) {
	if ( ! is_object( $user ) ) {
		$user = get_userdata( $user );
	}

	if ( ! $user || ! $user->exists() ) {
		return false;
	}
	$allow = true;
	if ( is_multisite() && is_user_spammy( $user ) ) {
		$allow = false;
	}

	/**
	 * Filters whether to allow a password to be reset.
	 *
	 * @since 2.7.0
	 *
	 * @param bool $allow   Whether to allow the password to be reset. Default true.
	 * @param int  $user_id The ID of the user attempting to reset a password.
	 */
	return apply_filters( 'allow_password_reset', $allow, $user->ID );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘allow_password_reset’, bool $allow, int $user_id )

Filters whether to allow a password to be reset.

UsesDescription
is_user_spammy()wp-includes/ms-functions.php

Determines whether a user is marked as a spammer, based on user login.

get_userdata()wp-includes/pluggable.php

Retrieves user info by user ID.

is_multisite()wp-includes/load.php

Determines whether Multisite is enabled.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 2 moreShow less
Used byDescription
get_password_reset_key()wp-includes/user.php

Creates, stores, then returns a password reset key for user.

WP_Users_List_Table::single_row()wp-admin/includes/class-wp-users-list-table.php

Generates HTML for a single row on the users.php admin panel.

Changelog

VersionDescription
6.3.0Introduced.

User Contributed Notes

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

    You can prevent specific user roles from reseting passwords using this filter like below

    add_filter( 'allow_password_reset', 'wpdocs_disallow_password_reset' );

function wpdocs_disallow_password_reset( $allow, $user_id ) {
	$user = get_userdata( $user_id );
	
	if ( in_array( 'author', (array) $user->roles ) ) {
		return false;
	} 

	return $allow;
}

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