Changeset 6336

Timestamp:

09/16/2012 03:29:15 PM (12 years ago)

Author:

boonebgorges

Message:

Use bp_core_validate_email_address() during registration

This centralizes email validation between registration and the Settings
component.

Also introduces bp_core_add_validation_errors(), a utility function for
converting the return value of validation functions into WP_Error-style
messages. This can be used in the future, if better username validation
functions are introduced.

Fixes #4486

File:

• trunk/bp-members/bp-members-functions.php (modified) (3 diffs)

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

@@ -1039 +1039 @@
 
 /**
+ * Add the appropriate errors to a WP_Error object, given results of a validation test
+ *
+ * Functions like bp_core_validate_email_address() return a structured array
+ * of error codes. bp_core_add_validation_error_messages() takes this array and
+ * parses, adding the appropriate error messages to the WP_Error object.
+ *
+ * @since BuddyPress (1.7)
+ * @see bp_core_validate_email_address()
+ *
+ * @param obj $errors WP_Error object
+ * @param array $validation_results The return value of a validation function
+ *   like bp_core_validate_email_address()
+ */
+function bp_core_add_validation_error_messages( WP_Error $errors, $validation_results ) {
+    if ( ! empty( $validation_results['invalid'] ) )
+        $errors->add( 'user_email', __( 'Please check your email address.', 'buddypress' ) );
+
+    if ( ! empty( $validation_results['domain_banned'] ) )
+        $errors->add( 'user_email',  __( 'Sorry, that email address is not allowed!', 'buddypress' ) );
+
+    if ( ! empty( $validation_results['domain_not_allowed'] ) )
+        $errors->add( 'user_email', __( 'Sorry, that email address is not allowed!', 'buddypress' ) );
+
+    if ( ! empty( $validation_results['in_use'] ) )
+        $errors->add( 'user_email', __( 'Sorry, that email address is already used!', 'buddypress' ) );
+}
+
+/**
  * Validate a user name and email address when creating a new user.
- *
- * @todo Refactor to use bp_core_validate_email_address()
  *
  * @param string $user_name Username to validate
@@ -1050 +1076 @@
 
     $errors = new WP_Error();
-    $user_email = sanitize_email( $user_email );
 
     // Apply any user_login filters added by BP or other plugins before validating
@@ -1079 +1104 @@
         $errors->add( 'user_name', __( 'Sorry, usernames must have letters too!', 'buddypress' ) );
 
-    if ( !is_email( $user_email ) )
-        $errors->add( 'user_email', __( 'Please check your email address.', 'buddypress' ) );
-
-    if ( function_exists( 'is_email_address_unsafe' ) && is_email_address_unsafe( $user_email ) )
-        $errors->add( 'user_email',  __( 'Sorry, that email address is not allowed!', 'buddypress' ) );
-
-    $limited_email_domains = get_site_option( 'limited_email_domains', 'buddypress' );
-
-    if ( is_array( $limited_email_domains ) && empty( $limited_email_domains ) == false ) {
-        $emaildomain = substr( $user_email, 1 + strpos( $user_email, '@' ) );
-
-        if ( in_array( $emaildomain, (array) $limited_email_domains ) == false )
-            $errors->add( 'user_email', __( 'Sorry, that email address is not allowed!', 'buddypress' ) );
-    }
-
     // Check if the username has been used already.
     if ( username_exists( $user_name ) )
         $errors->add( 'user_name', __( 'Sorry, that username already exists!', 'buddypress' ) );
 
-    // Check if the email address has been used already.
-    if ( email_exists( $user_email ) )
-        $errors->add( 'user_email', __( 'Sorry, that email address is already used!', 'buddypress' ) );
-
+    // Validate the email address and process the validation results into
+    // error messages
+    $validate_email = bp_core_validate_email_address( $user_email );
+    bp_core_add_validation_error_messages( $errors, $validate_email );
+
+    // Assemble the return array
     $result = array( 'user_name' => $user_name, 'user_email' => $user_email, 'errors' => $errors );