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

trunk/src/bp-messages/classes/class-bp-messages-rest-controller.php

@@ -125 +125 @@
             'type'                => $request->get_param( 'type' ),
             'page'                => $request->get_param( 'page' ),
+            'includes'            => $request->get_param( 'includes' ),
             'per_page'            => $request->get_param( 'per_page' ),
             'search_terms'        => $request->get_param( 'search' ),
@@ -1540 +1541 @@
 
         $params['box'] = array(
-            'description'       => __( 'Filter the result by box.', 'buddypress' ),
+            'description'       => __( 'Filter threads by the mailbox type.', 'buddypress' ),
             'default'           => 'inbox',
             'type'              => 'string',
@@ -1549 +1550 @@
 
         $params['type'] = array(
-            'description'       => __( 'Filter the result by thread status.', 'buddypress' ),
+            'description'       => __( 'Filter threads by the status.', 'buddypress' ),
             'default'           => 'all',
             'type'              => 'string',
@@ -1563 +1564 @@
             'required'          => true,
             'sanitize_callback' => 'absint',
+            'validate_callback' => 'rest_validate_request_arg',
+        );
+
+        $params['includes'] = array(
+            'description'       => __( 'Filter threads by recipient IDs.', 'buddypress' ),
+            'default'           => array(),
+            'type'              => 'array',
+            'sanitize_callback' => 'wp_parse_id_list',
             'validate_callback' => 'rest_validate_request_arg',
         );