BP_REST_Messages_Endpoint::search_thread_items( WP_REST_Request $request )

Search Existing thread by user and recipient for the message.

Description

Parameters

$request: (Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-messages/classes/class-bp-rest-messages-endpoint.php

public function search_thread_items( $request ) {
    $user_id      = $request->get_param( 'user_id' );
    $recipient_id = (array) $request->get_param( 'recipient_id' );
 
    if ( empty( $user_id ) ) {
        $user_id = bp_loggedin_user_id();
    }
 
    $retval = array();
 
    if ( class_exists( 'BP_Messages_Message' ) && method_exists( 'BP_Messages_Message', 'get_existing_thread' ) ) {
        $thread_id = BP_Messages_Message::get_existing_thread( $recipient_id, $user_id );
 
        if ( ! empty( $thread_id ) ) {
            $thread = $this->get_thread_object( $thread_id );
 
            $retval = $this->prepare_response_for_collection(
                $this->prepare_item_for_response( $thread, $request )
            );
        }
    }
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a thread id is fetched via the REST API.
     *
     * @since 0.1.0
     *
     * @param WP_REST_Request  $request  The request sent to the API.
     *
     * @param WP_REST_Response $response The response data.
     */
    do_action( 'bp_rest_messages_search_thread_items', $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::get_thread_object()	Get thread object.
bp-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::prepare_item_for_response()	Prepares thread data for return as an object.
bp-messages/classes/class-bp-rest-messages-endpoint.php: bp_rest_messages_search_thread_items	Fires after a thread id is fetched via the REST API.
bp-messages/classes/class-bp-messages-message.php: BP_Messages_Message::get_existing_thread()	Get existsing thread which matches the recipients
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents