Changeset 10585

Timestamp:

02/12/2016 11:29:33 PM (9 years ago)

Author:

r-a-y

Message:

Messages: Return generic WP Error in messages_new_message() when necessary.

In #6535, 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.

See #6894 (trunk).

Location:

trunk

Files:

• src/bp-messages/bp-messages-functions.php (modified) (1 diff)
• tests/phpunit/testcases/messages/functions.php (modified) (1 diff)

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

@@ -176 +176 @@
 
     // Bail if message failed to send.
-    if ( ! $message->send() ) {
+    $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' ) );
+            }
+        }
+
         return false;
     }

trunk/tests/phpunit/testcases/messages/functions.php

@@ -59 +59 @@
         $this->assertSame( 'Message could not be sent because you have entered an invalid username. Please try again.', $t1->get_error_message() );
     }
+
+    /**
+     * @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();
+    }
 }