Changeset 11153 for trunk/src/bp-messages/classes/class-bp-messages-thread.php

Timestamp:

09/22/2016 01:28:23 AM (8 years ago)

Author:

boonebgorges

Message:

Accept a $user_id parameter in messages_delete_thread().

Previously, this stack assumed the logged-in user, which made it very
difficult to delete threads for arbitrary users without touching the
database directly.

Props jdgrimes.
Fixes #7235.

File:

• trunk/src/bp-messages/classes/class-bp-messages-thread.php (modified) (3 diffs)

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

@@ -327 +327 @@
      *
      * @since 1.0.0
+     * @since 2.7.0 The $user_id parameter was added. Previously the current user
+     *              was always assumed.
      *
      * @param int $thread_id The message thread ID.
+     * @param int $user_id The ID of the user in the thread to mark messages as
+     *                     deleted for. Defaults to the current logged-in user.
+     *
      * @return bool
      */
-    public static function delete( $thread_id = 0 ) {
+    public static function delete( $thread_id = 0, $user_id = 0 ) {
         global $wpdb;
 
         $thread_id = (int) $thread_id;
+        $user_id = (int) $user_id;
+
+        if ( empty( $user_id ) ) {
+            $user_id = bp_loggedin_user_id();
+        }
 
         /**
@@ -340 +350 @@
          *
          * @since 2.2.0
+         * @since 2.7.0 The $user_id parameter was added.
          *
          * @param int $thread_id ID of the thread being deleted.
+         * @param int $user_id   ID of the user that the thread is being deleted for.
          */
-        do_action( 'bp_messages_thread_before_mark_delete', $thread_id );
+        do_action( 'bp_messages_thread_before_mark_delete', $thread_id, $user_id );
 
         $bp = buddypress();
 
         // 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() ) );
+        $wpdb->query( $wpdb->prepare( "UPDATE {$bp->messages->table_name_recipients} SET is_deleted = 1 WHERE thread_id = %d AND user_id = %d", $thread_id, $user_id ) );
 
         // Get the message ids in order to pass to the action.
@@ -399 +408 @@
          *
          * @since 2.2.0
+         * @since 2.7.0 The $user_id parameter was added.
          *
          * @param int   $thread_id   ID of the thread being deleted.
          * @param array $message_ids IDs of messages being deleted.
+         * @param int   $user_id     ID of the user the threads were deleted for.
          */
-        do_action( 'bp_messages_thread_after_delete', $thread_id, $message_ids );
+        do_action( 'bp_messages_thread_after_delete', $thread_id, $message_ids, $user_id );
 
         return true;