Contents

Code Reference Classes BP_REST_Messages_Actions_Endpoint BP_REST_Messages_Actions_Endpoint::action_items()

BP_REST_Messages_Actions_Endpoint::action_items( WP_REST_Request $request )

Perform Action on the Message Thread.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

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

102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
public function action_items( $request ) {
    $action    = $request->get_param( 'action' );
    $value     = $request->get_param( 'value' );
    $thread_id = $request->get_param( 'id' );
 
    switch ( $action ) {
        case 'delete_messages':
            $retval = $this->rest_delete_messages( $thread_id, $value );
            break;
        case 'hide_thread':
            $retval = $this->rest_hide_thread( $thread_id, $value );
            break;
        case 'unread':
            $retval = $this->rest_unread_thread( $thread_id, $value );
            break;
    }
 
    if ( is_wp_error( $retval ) ) {
        return $retval;
    }
 
    // Clear recipients cache after update hidden property.
    wp_cache_delete( 'thread_recipients_' . $thread_id, 'bp_messages' );
 
    $thread = new BP_Messages_Thread( $thread_id );
 
    $retval = $this->prepare_response_for_collection(
        $this->message_endppoint->prepare_item_for_response( $thread, $request )
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a thread is fetched via the REST API.
     *
     * @param BP_Messages_Thread $thread  Thread object.
     * @param WP_REST_Response   $retval  The response data.
     * @param WP_REST_Request    $request The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_messages_action_items', $thread, $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-actions-endpoint.php: BP_REST_Messages_Actions_Endpoint::rest_delete_messages()

Delete thread messages by logged in users.
bp-messages/classes/class-bp-rest-messages-actions-endpoint.php: BP_REST_Messages_Actions_Endpoint::rest_hide_thread()

Hide unhide message thread based on the logged in user.
bp-messages/classes/class-bp-rest-messages-actions-endpoint.php: BP_REST_Messages_Actions_Endpoint::rest_unread_thread()

Read/Unread message thread based on the logged in user.
bp-messages/classes/class-bp-rest-messages-actions-endpoint.php: bp_rest_messages_action_items

Fires after a thread is fetched via the REST API.
bp-messages/classes/class-bp-messages-thread.php: BP_Messages_Thread::__construct()

Constructor.

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.