Changeset 10286

Timestamp:

10/19/2015 07:47:01 PM (10 years ago)

Author:

r-a-y

Message:

Messages: Return context-appropriate error messages for messages_new_message().

This commit introduces the error_type parameter in the
messages_new_message() function, which allows for us to return
descriptive error messages to the user when 'error_type' is set to
'wp_error'.

This most notably addresses an issue when entering an invalid username
when composing a new private message.

Commit also includes a unit test.

Fixes #6535.

Location:

trunk

Files:

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

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

@@ -85 +85 @@
 
             // Attempt to send the message
-            $thread_id  = messages_new_message( array(
+            $send = messages_new_message( array(
                 'recipients' => $recipients,
                 'subject'    => $_POST['subject'],
-                'content'    => $_POST['content']
+                'content'    => $_POST['content'],
+                'error_type' => 'wp_error'
             ) );
 
             // Send the message and redirect to it
-            if ( ! empty( $thread_id ) ) {
+            if ( true === is_int( $send ) ) {
                 $success     = true;
                 $feedback    = __( 'Message successfully sent.', 'buddypress' );
                 $view        = trailingslashit( $member_messages . 'view' );
-                $redirect_to = trailingslashit( $view . $thread_id );
+                $redirect_to = trailingslashit( $view . $send );
 
             // Message could not be sent
             } else {
                 $success  = false;
-                $feedback = __( 'Message was not sent. Please try again.', 'buddypress' );
+                $feedback = $send->get_error_message();
             }
         }

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

@@ -17 +17 @@
 /**
  * Create a new message.
+ *
+ * @since 2.4.0 Added 'error_type' as an additional $args parameter.
  *
  * @param array|string $args {
@@ -32 +34 @@
  *     @type string $content    Content of the message. Cannot be empty.
  *     @type string $date_sent  Date sent, in 'Y-m-d H:i:s' format. Default: current date/time.
+ *     @type string $error_type Optional. Error type. Either 'bool' or 'wp_error'. Default: 'bool'.
  * }
  * @return int|bool ID of the message thread on success, false on failure.
@@ -44 +47 @@
         'subject'    => false,
         'content'    => false,
-        'date_sent'  => bp_core_current_time()
+        'date_sent'  => bp_core_current_time(),
+        'error_type' => 'bool'
     ), 'messages_new_message' );
 
     // Bail if no sender or no content
     if ( empty( $r['sender_id'] ) || empty( $r['content'] ) ) {
-        return false;
+        if ( 'wp_error' === $r['error_type'] ) {
+            if ( empty( $r['sender_id'] ) ) {
+                $error_code = 'messages_empty_sender';
+                $feedback = __( 'Your message was not sent. Please use a valid sender.', 'buddypress' );
+            } else {
+                $error_code = 'messages_empty_content';
+                $feedback = __( 'Your message was not sent. Please enter some content.', 'buddypress' );
+            }
+
+            return new WP_Error( $error_code, $feedback );
+
+        } else {
+            return false;
+        }
     }
 
@@ -83 +100 @@
         // Bail if no recipients
         if ( empty( $r['recipients'] ) ) {
-            return false;
+            if ( 'wp_error' === $r['error_type'] ) {
+                return new WP_Error( 'message_empty_recipients', __( 'Message could not be sent. Please enter a recipient.', 'buddypress' ) );
+            } else {
+                return false;
+            }
         }
 
@@ -139 +160 @@
         $recipient_ids = array_unique( $recipient_ids );
         if ( empty( $recipient_ids ) ) {
-            return false;
+            if ( 'wp_error' === $r['error_type'] ) {
+                return new WP_Error( 'message_invalid_recipients', __( 'Message could not be sent because you have entered an invalid username. Please try again.', 'buddypress' ) );
+            } else {
+                return false;
+            }
         }
 

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

@@ -42 +42 @@
     }
 
+    /**
+     * @group messages_new_message
+     */
+    public function test_messages_new_message_invalid_recipient_error_message() {
+        $u1 = $this->factory->user->create();
+
+        // attempt to send a private message to an invalid username
+        $t1 = messages_new_message( array(
+            'sender_id'  => $u1,
+            'recipients' => array( 'homerglumpkin' ),
+            'subject'    => 'A new message',
+            'content'    => 'Hey there!',
+            'error_type' => 'wp_error'
+        ) );
+
+        $this->assertSame( 'Message could not be sent because you have entered an invalid username. Please try again.', $t1->get_error_message() );
+    }
 }