<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][6336] trunk/bp-members/bp-members-functions.php: Use bp_core_validate_email_address() during registration</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/6336">6336</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2012-09-16 15:29:15 +0000 (Sun, 16 Sep 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>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 <a href="http://buddypress.trac.wordpress.org/ticket/4486">#4486</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpmembersbpmembersfunctionsphp">trunk/bp-members/bp-members-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-functions.php (6335 => 6336)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-functions.php 2012-09-16 03:36:25 UTC (rev 6335)
+++ trunk/bp-members/bp-members-functions.php 2012-09-16 15:29:15 UTC (rev 6336)
</span><span class="lines">@@ -1038,10 +1038,36 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * 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' ) );
+}
+
+/**
</ins><span class="cx"> * Validate a user name and email address when creating a new user.
</span><span class="cx"> *
</span><del>- * @todo Refactor to use bp_core_validate_email_address()
- *
</del><span class="cx"> * @param string $user_name Username to validate
</span><span class="cx"> * @param string $user_email Email address to validate
</span><span class="cx"> * @return array Results of user validation including errors, if any
</span><span class="lines">@@ -1049,7 +1075,6 @@
</span><span class="cx"> function bp_core_validate_user_signup( $user_name, $user_email ) {
</span><span class="cx">
</span><span class="cx"> $errors = new WP_Error();
</span><del>- $user_email = sanitize_email( $user_email );
</del><span class="cx">
</span><span class="cx"> // Apply any user_login filters added by BP or other plugins before validating
</span><span class="cx"> $user_name = apply_filters( 'pre_user_login', $user_name );
</span><span class="lines">@@ -1078,29 +1103,16 @@
</span><span class="cx"> if ( $match[0] == $user_name )
</span><span class="cx"> $errors->add( 'user_name', __( 'Sorry, usernames must have letters too!', 'buddypress' ) );
</span><span class="cx">
</span><del>- 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' ) );
- }
-
</del><span class="cx"> // Check if the username has been used already.
</span><span class="cx"> if ( username_exists( $user_name ) )
</span><span class="cx"> $errors->add( 'user_name', __( 'Sorry, that username already exists!', 'buddypress' ) );
</span><span class="cx">
</span><del>- // 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' ) );
</del><ins>+ // 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 );
</ins><span class="cx">
</span><ins>+ // Assemble the return array
</ins><span class="cx"> $result = array( 'user_name' => $user_name, 'user_email' => $user_email, 'errors' => $errors );
</span><span class="cx">
</span><span class="cx"> // Apply WPMU legacy filter
</span></span></pre>
</div>
</div>
</body>
</html>