Changeset 12984

Timestamp:

07/02/2021 01:10:12 AM (3 years ago)

Author:

espellcaste

Message:

Adding a user ID parameter to the messages_mark_thread_read and messages_mark_thread_unread functions.

Allowing those functions to be used in other BuddyPress API.

Props imath
Fixes #8489 (trunk)

Location:

trunk

Files:

• src/bp-messages/bp-messages-functions.php (modified) (2 diffs)
• src/bp-messages/classes/class-bp-messages-thread.php (modified) (4 diffs)
• tests/phpunit/testcases/messages/class.bp-messages-thread.php (modified) (1 diff)

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

@@ -325 +325 @@
  * Wrapper for {@link BP_Messages_Thread::mark_as_read()}.
  *
- * @param int $thread_id ID of the thread.
+ * @since 9.0.0 Added the `user_id` parameter.
+ *
+ * @param int $thread_id The message thread ID.
+ * @param int $user_id   Optional. The user the thread will be marked as read.
  *
  * @return false|int Number of threads marked as read or false on error.
  */
-function messages_mark_thread_read( $thread_id ) {
-    return BP_Messages_Thread::mark_as_read( $thread_id );
+function messages_mark_thread_read( $thread_id, $user_id = 0 ) {
+    return BP_Messages_Thread::mark_as_read( $thread_id, $user_id );
 }
 
@@ -338 +341 @@
  * Wrapper for {@link BP_Messages_Thread::mark_as_unread()}.
  *
- * @param int $thread_id ID of the thread.
+ * @since 9.0.0 Added the `user_id` parameter.
+ *
+ * @param int $thread_id The message thread ID.
+ * @param int $user_id   Optional. The user the thread will be marked as unread.
  *
  * @return false|int Number of threads marked as unread or false on error.
  */
-function messages_mark_thread_unread( $thread_id ) {
-    return BP_Messages_Thread::mark_as_unread( $thread_id );
+function messages_mark_thread_unread( $thread_id, $user_id = 0 ) {
+    return BP_Messages_Thread::mark_as_unread( $thread_id, $user_id );
 }
 

trunk/src/bp-messages/classes/class-bp-messages-thread.php

@@ -613 +613 @@
      *
      * @since 1.0.0
+     * @since 9.0.0 Added the `user_id` parameter.
      *
      * @param int $thread_id The message thread ID.
+     * @param int $user_id   The user the thread will be marked as read.
      *
      * @return false|int Number of threads marked as read or false on error.
      */
-    public static function mark_as_read( $thread_id = 0 ) {
-        global $wpdb;
-
-        $user_id =
-            bp_displayed_user_id() ?
-            bp_displayed_user_id() :
-            bp_loggedin_user_id();
+    public static function mark_as_read( $thread_id = 0, $user_id = 0 ) {
+        global $wpdb;
+
+        if ( empty( $user_id ) ) {
+            $user_id =
+                bp_displayed_user_id() ?
+                bp_displayed_user_id() :
+                bp_loggedin_user_id();
+        }
 
         $bp     = buddypress();
@@ -636 +640 @@
          *
          * @since 2.8.0
+         * @since 9.0.0 Added the `user_id` parameter.
          *
          * @param int $thread_id The message thread ID.
+         * @param int $user_id   The user the thread will be marked as read.
          */
-        do_action( 'messages_thread_mark_as_read', $thread_id );
+        do_action( 'messages_thread_mark_as_read', $thread_id, $user_id );
 
         return $retval;
@@ -648 +654 @@
      *
      * @since 1.0.0
+     * @since 9.0.0 Added the `user_id` parameter.
      *
      * @param int $thread_id The message thread ID.
+     * @param int $user_id   The user the thread will be marked as unread.
      *
      * @return false|int Number of threads marked as unread or false on error.
      */
-    public static function mark_as_unread( $thread_id = 0 ) {
-        global $wpdb;
-
-        $user_id =
-            bp_displayed_user_id() ?
-            bp_displayed_user_id() :
-            bp_loggedin_user_id();
+    public static function mark_as_unread( $thread_id = 0, $user_id = 0 ) {
+        global $wpdb;
+
+        if ( empty( $user_id ) ) {
+            $user_id =
+                bp_displayed_user_id() ?
+                bp_displayed_user_id() :
+                bp_loggedin_user_id();
+        }
 
         $bp     = buddypress();
@@ -671 +681 @@
          *
          * @since 2.8.0
+         * @since 9.0.0 Added the `user_id` parameter.
          *
          * @param int $thread_id The message thread ID.
+         * @param int $user_id   The user the thread will be marked as unread.
          */
-        do_action( 'messages_thread_mark_as_unread', $thread_id );
+        do_action( 'messages_thread_mark_as_unread', $thread_id, $user_id );
 
         return $retval;

trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php

@@ -320 +320 @@
 
     /**
+     * @group cache
+     */
+    public function test_marking_a_thread_as_read_with_specific_user_id() {
+        $u1      = self::factory()->user->create();
+        $u2      = self::factory()->user->create();
+        $message = self::factory()->message->create_and_get( array(
+            'sender_id'  => $u1,
+            'recipients' => array( $u2 ),
+            'subject'    => 'Foo',
+        ) );
+
+        $thread_id = $message->thread_id;
+
+        // Cache should be populated.
+        $this->assertTrue( (bool) wp_cache_get( 'thread_recipients_' . $thread_id, 'bp_messages' ) );
+
+        // Mark thread as read.
+        messages_mark_thread_read( $thread_id, $u2 );
+
+        // Cache should be empty.
+        $this->assertFalse( wp_cache_get( 'thread_recipients_' . $thread_id, 'bp_messages' ) );
+
+        $thread = new BP_Messages_Thread( $thread_id );
+
+        $this->assertFalse( (bool) $thread->unread_count );
+        $this->assertFalse( (bool) $thread->recipients[ $u1 ]->unread_count );
+        $this->assertFalse( (bool) $thread->recipients[ $u2 ]->unread_count );
+    }
+
+    /**
+     * @group cache
+     */
+    public function test_marking_a_thread_as_unread_with_specific_user_id() {
+        $u1      = self::factory()->user->create();
+        $u2      = self::factory()->user->create();
+        $message = self::factory()->message->create_and_get( array(
+            'sender_id'  => $u1,
+            'recipients' => array( $u2 ),
+            'subject'    => 'Foo',
+        ) );
+
+        $thread_id = $message->thread_id;
+
+        // Cache should be populated.
+        $this->assertTrue( (bool) wp_cache_get( 'thread_recipients_' . $thread_id, 'bp_messages' ) );
+
+        // Mark thread as unread.
+        messages_mark_thread_unread( $thread_id, $u2 );
+
+        // Cache should be empty.
+        $this->assertFalse( wp_cache_get( 'thread_recipients_' . $thread_id, 'bp_messages' ) );
+
+        $thread = new BP_Messages_Thread( $thread_id );
+
+        $this->assertFalse( (bool) $thread->recipients[ $u1 ]->unread_count );
+        $this->assertTrue( (bool) $thread->recipients[ $u2 ]->unread_count );
+    }
+
+    /**
      * @group get_recipients
      * @group cache