Changeset 9185

Timestamp:

11/26/2014 06:08:54 AM (12 years ago)

Author:

r-a-y

Message:

Introduce 'bp_messages_thread_before_mark_delete' action.

This commit renames the 'bp_messages_thread_before_delete' action added in
r9165 to 'bp_messages_thread_before_mark_delete' and moves the
'bp_messages_thread_before_delete' hook where the message thread is
actually deleted.

The phpDoc for BP_Messages_Thread::delete() is also updated to accurately
outline what is happening in the class method.

See #5193.

File:

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

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

@@ -233 +233 @@
 
         /**
-         * Delete a message thread.
+         * Mark messages in a thread as deleted or delete all messages in a thread.
+         *
+         * Note: All messages in a thread are deleted once every recipient in a thread
+         * has marked the thread as deleted.
          *
          * @since BuddyPress (1.0.0)
@@ -244 +247 @@
 
                 /**
-                 * Fires before a message thread is deleted.
+                 * Fires before a message thread is marked as deleted.
                  *
                  * @since BuddyPress (2.2.0)
@@ -250 +253 @@
                  * @param int $thread_id ID of the thread being deleted.
                  */
-                do_action( 'bp_messages_thread_before_delete', $thread_id );
+                do_action( 'bp_messages_thread_before_mark_delete', $thread_id );
 
                 // Mark messages as deleted
+                //
+                // @todo the reliance on bp_loggedin_user_id() sucks for plugins
+                //       refactor this method to accept a $user_id parameter
                 $wpdb->query( $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET is_deleted = 1 WHERE thread_id = %d AND user_id = %d", $thread_id, bp_loggedin_user_id() ) );
 
@@ -259 +265 @@
 
                 // Check to see if any more recipients remain for this message
-                // if not, then delete the message from the database.
                 $recipients = $wpdb->get_results( $wpdb->prepare( "SELECT id FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d AND is_deleted = 0", $thread_id ) );
 
+                // No more recipients so delete all messages associated with the thread
                 if ( empty( $recipients ) ) {
+                        /**
+                         * Fires before an entire message thread is deleted.
+                         *
+                         * @since BuddyPress (2.2.0)
+                         *
+                         * @param int   $thread_id   ID of the thread being deleted.
+                         * @param array $message_ids IDs of messages being deleted.
+                         */
+                        do_action( 'bp_messages_thread_before_delete', $thread_id, $message_ids );
+
                         // Delete all the messages
                         $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->messages->table_name_messages} WHERE thread_id = %d", $thread_id ) );