Changeset 9165

Timestamp:

11/22/2014 01:49:35 AM (10 years ago)

Author:

boonebgorges

Message:

Add some actions and filters to BP_Messages_Thread.

Props slaFFik.
See #5193.

File:

• trunk/src/bp-messages/bp-messages-classes.php (modified) (7 diffs)

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

@@ -155 +155 @@
             $this->unread_count = $this->recipients[bp_loggedin_user_id()]->unread_count;
         }
+
+        /**
+         * Fires after a BP_Messages_Thread object has been populated.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param BP_Messages_Thread Message thread object.
+         */
+        do_action( 'bp_messages_thread_post_populate', $this );
     }
 
@@ -184 +193 @@
      * @since BuddyPress (1.0.0)
      *
-     * @return object
+     * @return array
      */
     public function get_recipients() {
@@ -192 +201 @@
         $results    = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d", $this->thread_id ) );
 
-        foreach ( (array) $results as $recipient )
+        foreach ( (array) $results as $recipient ) {
             $recipients[$recipient->user_id] = $recipient;
-
-        return $recipients;
+        }
+
+        /**
+         * Filters the recipients of a message thread.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param array $recipients Array of recipient objects.
+         * @param int   $thread_id  ID of the current thread.
+                 */
+        return apply_filters( 'bp_messages_thread_get_recipients', $recipients, $this->thread_id );
     }
 
@@ -210 +228 @@
     public static function delete( $thread_id ) {
         global $wpdb, $bp;
+
+        /**
+         * Fires before a message thread is deleted.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param int $thread_id ID of the thread being deleted.
+         */
+        do_action( 'bp_messages_thread_before_delete', $thread_id );
 
         // Mark messages as deleted
@@ -229 +256 @@
         }
 
-        do_action( 'messages_thread_deleted_thread', $message_id );
+        /**
+         * Fires after a message thread is deleted.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param int $thread_id ID of the thread being deleted.
+         */
+        do_action( 'bp_messages_thread_after_delete', $message_id );
 
         return true;
@@ -295 +329 @@
         }
 
-        return array( 'threads' => &$threads, 'total' => (int) $total_threads );
+        /**
+         * Filters the results of the query for a user's message threads.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param array $value {
+         *     @type array $threads       Array of threads. Passed by reference.
+         *     @type int   $total_threads Number of threads found by the query.
+         * }
+         */
+        return apply_filters( 'bp_messages_thread_current_threads', array( 'threads' => &$threads, 'total' => (int) $total_threads ) );
     }
 
@@ -418 +462 @@
         }
 
-        return (int) $unread_count;
+        /**
+         * Filters a user's unread message count.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param int $unread_count Unread message count.
+         * @param int $user_id      ID of the user.
+         */
+        return apply_filters( 'messages_thread_get_inbox_count', (int) $unread_count, $user_id );
     }