Changeset 11310

Timestamp:

12/19/2016 10:51:10 PM (8 years ago)

Author:

slaffik

Message:

Messages: improvements to thread mark as read/unread.

Added new actions, so developers can now do their jobs when thread was marked as read/unread. Made wrappers like messages_mark_thread_read() meaningful by actually providing a return value.

See #5193.

Location:

trunk/src/bp-messages

Files:

• bp-messages-functions.php (modified) (2 diffs)
• classes/class-bp-messages-thread.php (modified) (2 diffs)

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

@@ -326 +326 @@
  *
  * @param int $thread_id ID of the thread.
+ *
+ * @return false|int Number of threads marked as read or false on error.
  */
 function messages_mark_thread_read( $thread_id ) {
@@ -337 +339 @@
  *
  * @param int $thread_id ID of the thread.
+ *
+ * @return false|int Number of threads marked as unread or false on error.
  */
 function messages_mark_thread_unread( $thread_id ) {

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

@@ -609 +609 @@
      *
      * @param int $thread_id The message thread ID.
+     *
+     * @return false|int Number of threads marked as read or false on error.
      */
     public static function mark_as_read( $thread_id = 0 ) {
         global $wpdb;
 
-        $bp  = buddypress();
-        $sql = $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET unread_count = 0 WHERE user_id = %d AND thread_id = %d", bp_loggedin_user_id(), $thread_id );
-        $wpdb->query( $sql );
+        $bp     = buddypress();
+        $retval = $wpdb->query( $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET unread_count = 0 WHERE user_id = %d AND thread_id = %d", bp_loggedin_user_id(), $thread_id ) );
 
         wp_cache_delete( 'thread_recipients_' . $thread_id, 'bp_messages' );
         wp_cache_delete( bp_loggedin_user_id(), 'bp_messages_unread_count' );
+
+        /**
+         * Fires when messages thread was marked as read.
+         *
+         * @since 2.8.0
+         *
+         * @param int $thread_id The message thread ID.
+         */
+        do_action( 'messages_thread_mark_as_read', $thread_id );
+
+        return $retval;
     }
 
@@ -627 +639 @@
      *
      * @param int $thread_id The message thread ID.
+     *
+     * @return false|int Number of threads marked as unread or false on error.
      */
     public static function mark_as_unread( $thread_id = 0 ) {
         global $wpdb;
 
-        $bp  = buddypress();
-        $sql = $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET unread_count = 1 WHERE user_id = %d AND thread_id = %d", bp_loggedin_user_id(), $thread_id );
-        $wpdb->query( $sql );
+        $bp     = buddypress();
+        $retval = $wpdb->query( $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET unread_count = 1 WHERE user_id = %d AND thread_id = %d", bp_loggedin_user_id(), $thread_id ) );
 
         wp_cache_delete( 'thread_recipients_' . $thread_id, 'bp_messages' );
         wp_cache_delete( bp_loggedin_user_id(), 'bp_messages_unread_count' );
+
+        /**
+         * Fires when messages thread was marked as unread.
+         *
+         * @since 2.8.0
+         *
+         * @param int $thread_id The message thread ID.
+         */
+        do_action( 'messages_thread_mark_as_unread', $thread_id );
+
+        return $retval;
     }