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

Timestamp:

11/03/2024 05:55:47 PM (8 months ago)

Author:

espellcaste

Message:

Messages: filter threads by recipient IDs.

bp_has_message_threads (and the BP REST API) can filter thread(s) messages by recipient IDs. Very useful when trying to identify if a member already messaged another.

Props imath and slaFFik.

See ​https://github.com/buddypress/BP-REST/issues/455
Closes ​https://github.com/buddypress/buddypress/pull/394
See #9229 and #9145
Fixes #9157

File:

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

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

@@ -673 +673 @@
      *
      * @since 1.0.0
+     * @since 15.0.0 Added the `$includes` parameter.
      *
      * @global wpdb $wpdb WordPress database object.
@@ -685 +686 @@
      *     @type int      $limit               The number of messages to get. Defaults to null.
      *     @type int      $page                The page number to get. Defaults to null.
+     *     @type array    $includes            Filter threads by recipient IDs.
      *     @type string   $search_terms        The search term to use. Defaults to ''.
      *     @type array    $meta_query          Meta query arguments. See WP_Meta_Query for more details.
@@ -731 +733 @@
                 'type'                => 'all',
                 'limit'               => null,
+                'includes'            => array(),
                 'page'                => null,
                 'recipients_page'     => null,
@@ -741 +744 @@
         );
 
-        $pag_sql        = $type_sql = $search_sql = $user_id_sql = $sender_sql = '';
+        $pag_sql        = $type_sql = $search_sql = $user_id_sql = $includes_sql = $sender_sql = '';
         $meta_query_sql = array(
             'join'  => '',
@@ -795 +798 @@
         $bp = buddypress();
 
+        if ( ! empty( $r['includes'] ) && is_array( $r['includes'] ) ) {
+            $includes_ids = array_filter(
+                wp_parse_id_list( $r['includes'] ),
+                function ( $recipient_id ) use ( $r ) {
+                    // Filter out the current user ID, if available.
+                    return $recipient_id !== $r['user_id'];
+                }
+            );
+
+            if ( ! empty( $includes_ids ) ) {
+                $includes_ids = implode( ',', $includes_ids );
+                $includes_sql = "AND r.thread_id IN (SELECT thread_id FROM {$bp->messages->table_name_recipients} WHERE user_id in ({$includes_ids}))";
+            }
+        }
+
         // Set up SQL array.
         $sql           = array();
         $sql['select'] = 'SELECT m.thread_id, MAX(m.date_sent) AS date_sent';
         $sql['from']   = "FROM {$bp->messages->table_name_recipients} r INNER JOIN {$bp->messages->table_name_messages} m ON m.thread_id = r.thread_id {$meta_query_sql['join']}";
-        $sql['where']  = "WHERE {$deleted_sql} {$user_id_sql} {$sender_sql} {$type_sql} {$search_sql} {$meta_query_sql['where']}";
+        $sql['where']  = "WHERE {$deleted_sql} {$user_id_sql} {$sender_sql} {$includes_sql} {$type_sql} {$search_sql} {$meta_query_sql['where']}";
         $sql['misc']   = "GROUP BY m.thread_id ORDER BY date_sent DESC {$pag_sql}";
 
@@ -811 +829 @@
         $sql['select'] = 'SELECT COUNT( DISTINCT m.thread_id )';
         unset( $sql['misc'] );
+
         $total_threads = $wpdb->get_var( implode( ' ', $sql ) );
 
@@ -841 +860 @@
          * @since 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.
+         * @param array $results {
+         *     @type BP_Messages_Thread[] $threads       Array of threads. Passed by reference.
+         *     @type int                  $total_threads Number of threads found by the query.
          * }
-         *  @param array $r    Array of parameters.
+         *  @param array $r Array of parameters.
          */
         return apply_filters(