Dev Resources

  • Home
  • Reference
  • BuddyX Theme
  • Functions
  • Hooks
  • Classes
Filter by type:
Search
Browse: Home / Reference / Classes / WC_Shortcode_My_Account / WC_Shortcode_My_Account::check_password_reset_key()

WC_Shortcode_My_Account::check_password_reset_key( string $key, string $login )

Retrieves a user row based on password reset key and login.

Contents

  • Description
    • Parameters
    • Return
    • Source
  • Related
    • Uses
    • Used By
  • User Contributed Notes

Description #Description


Parameters #Parameters

$key

(Required) Hash to validate sending user's password.

$login

(Required) The user login.


Top ↑

Return #Return

(WP_User|bool) User's database row on success, false for invalid keys


Top ↑

Source #Source

File: includes/shortcodes/class-wc-shortcode-my-account.php

	public static function check_password_reset_key( $key, $login ) {
		// Check for the password reset key.
		// Get user data or an error message in case of invalid or expired key.
		$user = check_password_reset_key( $key, $login );

		if ( is_wp_error( $user ) ) {
			wc_add_notice( __( 'This key is invalid or has already been used. Please reset your password again if needed.', 'woocommerce' ), 'error' );
			return false;
		}

		return $user;
	}

Expand full source code Collapse full source code


Top ↑

Related #Related

Top ↑

Uses #Uses

Uses
Uses Description
includes/wc-notice-functions.php: wc_add_notice()

Add and store a notice.

Top ↑

Used By #Used By

Used By
Used By Description
includes/class-wc-form-handler.php: WC_Form_Handler::process_reset_password()

Handle reset password form.

includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::lost_password()

Lost password page handling.


Top ↑

User Contributed Notes #User Contributed Notes

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

Proudly powered by WordPress