Changeset 14069 for trunk/src/bp-messages/bp-messages-template.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/bp-messages-template.php (modified) (4 diffs)

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

@@ -19 +19 @@
  *
  * @since 1.0.0
+ * @since 15.0.0 Added the `$includes` parameter.
  *
  * @global BP_Messages_Box_Template $messages_template The message box template loop class.
@@ -32 +33 @@
  *     @type string   $type                Type of messages to return. Values: 'all', 'read', 'unread'
  *                                         Default: 'all'
+ *     @type array    $includes            Filter threads by recipient IDs.
  *     @type string   $search_terms        Terms to which to limit results. Default:
  *                                         the value of $_REQUEST['s'].
@@ -80 +82 @@
             'page_arg'            => 'mpage', // See https://buddypress.trac.wordpress.org/ticket/3679.
             'meta_query'          => array(),
+            'includes'            => array(),
             'recipients_page'     => null,
             'recipients_per_page' => null,
@@ -96 +99 @@
      * @since 1.1.0
      *
-     * @param bool                     $value             Whether or not the message has threads.
+     * @param bool                     $has_threads       Whether or not the message has threads.
      * @param BP_Messages_Box_Template $messages_template Current message box template object.
      * @param array                    $r                 Array of parsed arguments passed into function.