Changeset 12679 for trunk/src/bp-members/bp-members-functions.php

Timestamp:

07/04/2020 01:29:50 PM (4 years ago)

Author:

imath

Message:

BP Members: improve our password validation process

We're introducing a new function to validate the member's chosen password: bp_members_validate_user_password().

This function is primarly used to check the password is not empty, and to make sure the password confirmation matches the password. If it's the case, the function will return a WP_Error object with no error message. Otherwise this object will contain an error message.

Plugins can now use the bp_members_validate_user_password filter to add their own error messages according to a custom validation process. See the last unit tests of this commit for an example of use.

Props devnik, tharsheblows

Fixes #8066

File:

• trunk/src/bp-members/bp-members-functions.php (modified) (1 diff)

trunk/src/bp-members/bp-members-functions.php

@@ -1770 +1770 @@
 
 /**
+ * Validate a user password.
+ *
+ * @since 7.0.0
+ *
+ * @param string       $pass         The password.
+ * @param string       $confirm_pass The confirmed password.
+ * @param null|WP_User $userdata     Null or the userdata object when a member updates their password from front-end.
+ * @return WP_Error A WP error object possibly containing error messages.
+ */
+function bp_members_validate_user_password( $pass, $confirm_pass, $userdata = null ) {
+    $errors = new WP_Error();
+
+    if ( ! $pass || ! $confirm_pass ) {
+        $errors->add( 'missing_user_password', __( 'Please make sure you enter your password twice', 'buddypress' ) );
+    }
+
+    if ( $pass && $confirm_pass && $pass !== $confirm_pass ) {
+        $errors->add( 'mismatching_user_password', __( 'The passwords you entered do not match.', 'buddypress' ) );
+    }
+
+    /**
+     * Filter here to add password validation errors.
+     *
+     * @since 7.0.0
+     *
+     * @param WP_Error     $errors       Password validation errors.
+     * @param string       $pass         The password.
+     * @param string       $confirm_pass The confirmed password.
+     * @param null|WP_User $userdata     Null or the userdata object when a member updates their password from front-end.
+     */
+    return apply_filters( 'bp_members_validate_user_password', $errors, $pass, $confirm_pass, $userdata );
+}
+
+/**
  * Validate blog URL and title provided at signup.
  *