<!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][10792] trunk: Emails: Ensure that passing a known WP user email address to `bp_send_email()` will render the `{{recipient.name}}` token.</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 { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/10792">10792</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/10792","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>r-a-y</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-05-19 20:50:46 +0000 (Thu, 19 May 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Emails: Ensure that passing a known WP user email address to `bp_send_email()` will render the `{{recipient.name}}` token.
Commit also adds several unit tests for the `BP_Email_Recipient` class.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7044">#7044</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpemailrecipientphp">trunk/src/bp-core/classes/class-bp-email-recipient.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreclassbpemailrecipientphp">trunk/tests/phpunit/testcases/core/class-bp-email-recipient.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpemailrecipientphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-email-recipient.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-email-recipient.php 2016-05-19 18:04:47 UTC (rev 10791)
+++ trunk/src/bp-core/classes/class-bp-email-recipient.php 2016-05-19 20:50:46 UTC (rev 10792)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -55,19 +55,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $email_or_user, $name = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $name = sanitize_text_field( $name );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // User ID, WP_User object.
- if ( is_int( $email_or_user ) || is_object( $email_or_user ) ) {
- $this->user_object = is_object( $email_or_user ) ? $email_or_user : get_user_by( 'id', $email_or_user );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // User ID, email address or WP_User object.
+ if ( is_int( $email_or_user ) || ( is_string( $email_or_user ) && is_email( $email_or_user ) ) || is_object( $email_or_user ) ) {
+ // We already have a WP user.
+ if ( is_object( $email_or_user ) ) {
+ $this->user_object = $email_or_user;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $this->user_object ) {
- // This is escaped with esc_html in bp_core_get_user_displayname()
- $name = wp_specialchars_decode( bp_core_get_user_displayname( $this->user_object->ID ), ENT_QUOTES );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Query for WP user by user ID.
+ } elseif ( is_int( $email_or_user ) ) {
+ $this->user_object = get_user_by( 'id', $email_or_user );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->address = $this->user_object->user_email;
- $this->name = sanitize_text_field( $name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set email address.
+ if ( empty( $this->user_object ) && is_email( $email_or_user ) ) {
+ $address = $email_or_user;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Array, address, and name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Array or miscellaneous string.
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $email_or_user ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $email_or_user = array( $email_or_user => $name );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,11 +84,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $address = key( $email_or_user );
</span><span class="cx" style="display: block; padding: 0 10px"> $name = current( $email_or_user );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_email( $address ) ) {
- $this->address = sanitize_email( $address );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set address if we have one.
+ if ( ! empty( $address ) ) {
+ $this->address = sanitize_email( $address );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Still no user object; try to query user by email address.
+ if ( empty( $this->user_object ) ) {
+ $this->get_user( 'search-email' );
+ }
+
+ // We have a user object; so set address and name from DB.
+ if ( $this->user_object ) {
+ // This is escaped with esc_html in bp_core_get_user_displayname()
+ $wp_name = wp_specialchars_decode( bp_core_get_user_displayname( $this->user_object->ID ), ENT_QUOTES );
+
+ $this->address = $this->user_object->user_email;
+ $this->name = sanitize_text_field( $wp_name );
+
+ }
+
+ // Custom name override.
+ if ( $name ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->name = $name;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasescoreclassbpemailrecipientphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/core/class-bp-email-recipient.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/class-bp-email-recipient.php 2016-05-19 18:04:47 UTC (rev 10791)
+++ trunk/tests/phpunit/testcases/core/class-bp-email-recipient.php 2016-05-19 20:50:46 UTC (rev 10792)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,22 +47,78 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'Unit Test', $recipient->get_name() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_return_with_address_and_optional_name() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_return_with_known_address_and_optional_name() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $email = 'test@example.com';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $name = 'Custom';
+ $recipient = new BP_Email_Recipient( $email, $name );
+
+ $this->assertSame( 'test@example.com', $recipient->get_address() );
+ $this->assertSame( 'Custom', $recipient->get_name() );
+ }
+
+ public function test_return_with_known_address_and_empty_name() {
+ $email = 'test@example.com';
</ins><span class="cx" style="display: block; padding: 0 10px"> $recipient = new BP_Email_Recipient( $email );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 'test@example.com', $recipient->get_address() );
+
+ // Should fallback to WP user name.
+ $this->assertSame( 'Unit Test', $recipient->get_name() );
+ }
+
+ public function test_return_with_unknown_address_and_optional_name() {
+ $email = 'unknown@example.com';
+ $name = 'Custom';
+ $recipient = new BP_Email_Recipient( $email, $name );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $email, $recipient->get_address() );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( $name, $recipient->get_name() );
+ }
+
+ public function test_return_with_unknown_address_and_empty_name() {
+ $email = 'unknown@example.com';
+ $recipient = new BP_Email_Recipient( $email );
+
+ $this->assertSame( $email, $recipient->get_address() );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEmpty( $recipient->get_name() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_return_with_array_and_optional_name() {
- $email = 'test@example.com';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_return_with_unknown_array_and_optional_name() {
+ $email = 'unknown@example.com';
+ $name = 'Custom';
+ $recipient = new BP_Email_Recipient( array( $email => $name ) );
+
+ $this->assertSame( $email, $recipient->get_address() );
+ $this->assertSame( $name, $recipient->get_name() );
+ }
+
+ public function test_return_with_unknown_array_and_empty_name() {
+ $email = 'unknown@example.com';
</ins><span class="cx" style="display: block; padding: 0 10px"> $recipient = new BP_Email_Recipient( array( $email ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $email, $recipient->get_address() );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEmpty( $recipient->get_name() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_return_with_known_array_and_optional_name() {
+ $email = 'test@example.com';
+ $name = 'Custom';
+ $recipient = new BP_Email_Recipient( array( $email => $name ) );
+
+ $this->assertSame( $email, $recipient->get_address() );
+ $this->assertSame( $name, $recipient->get_name() );
+ }
+
+ public function test_return_with_known_array_and_empty_name() {
+ $email = 'test@example.com';
+ $recipient = new BP_Email_Recipient( array( $email ) );
+
+ $this->assertSame( $email, $recipient->get_address() );
+
+ // Should fallback to WP user name.
+ $this->assertSame( 'Unit Test', $recipient->get_name() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_should_return_empty_string_if_user_id_id_invalid() {
</span><span class="cx" style="display: block; padding: 0 10px"> $recipient = new BP_Email_Recipient( time() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>