<!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][10586] branches/2.4: Messages: Return generic WP Error in `messages_new_message()` when necessary.</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/10586">10586</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/10586","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-02-12 23:30:39 +0000 (Fri, 12 Feb 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'>Messages: Return generic WP Error in `messages_new_message()` when necessary.
In <a href="http://buddypress.trac.wordpress.org/ticket/6535">#6535</a>, we added an `'error_type'` parameter in `messages_new_message()`
that supports returning a WP Error object if error type is set to
`'wp_error'`. However, we did not return a WP error further down in the
`messages_new_message()` function, which can result in a potential fatal
error to occur.
This commit rectifies this and includes a unit test.
Anti-props r-a-y.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6894">#6894</a> (2.4-branch).</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches24srcbpmessagesbpmessagesfunctionsphp">branches/2.4/src/bp-messages/bp-messages-functions.php</a></li>
<li><a href="#branches24testsphpunittestcasesmessagesfunctionsphp">branches/2.4/tests/phpunit/testcases/messages/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches24srcbpmessagesbpmessagesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/2.4/src/bp-messages/bp-messages-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/2.4/src/bp-messages/bp-messages-functions.php 2016-02-12 23:29:33 UTC (rev 10585)
+++ branches/2.4/src/bp-messages/bp-messages-functions.php 2016-02-12 23:30:39 UTC (rev 10586)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -174,7 +174,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail if message failed to send.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $message->send() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $send = $message->send();
+ if ( false === is_int( $send ) ) {
+ if ( 'wp_error' === $r['error_type'] ) {
+ if ( is_wp_error( $send ) ) {
+ return $send;
+ } else {
+ return new WP_Error( 'message_generic_error', __( 'Message was not sent. Please try again.', 'buddypress' ) );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</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="branches24testsphpunittestcasesmessagesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/2.4/tests/phpunit/testcases/messages/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/2.4/tests/phpunit/testcases/messages/functions.php 2016-02-12 23:29:33 UTC (rev 10585)
+++ branches/2.4/tests/phpunit/testcases/messages/functions.php 2016-02-12 23:30:39 UTC (rev 10586)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,4 +58,35 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'Message could not be sent because you have entered an invalid username. Please try again.', $t1->get_error_message() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group messages_new_message
+ */
+ public function test_messages_new_message_wp_error_generic() {
+ $u1 = $this->factory->user->create();
+ $u2 = $this->factory->user->create();
+
+ // Emulate a plugin disabling messages.
+ add_action( 'messages_message_before_save', array( $this, 'remove_recipients_before_save' ) );
+
+ // send a private message
+ $t1 = messages_new_message( array(
+ 'sender_id' => $u1,
+ 'recipients' => array( $u2 ),
+ 'subject' => 'A new message',
+ 'content' => 'Hey there!',
+ 'error_type' => 'wp_error'
+ ) );
+
+ $this->assertNotEmpty( $t1->get_error_code() );
+
+ remove_action( 'messages_message_before_save', array( $this, 'remove_recipients_before_save' ) );
+ }
+
+ /**
+ * Helper method for test_messages_new_message_wp_error_generic().
+ */
+ public function remove_recipients_before_save( $message ) {
+ $message->recipients = array();
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>