BP_REST_Messages_Endpoint::prepare_message_for_response( BP_Messages_Message $message, WP_REST_Request $request )
Prepares message data for the REST response.
Description Description
Parameters Parameters
- $message
-
(Required) The Message object.
- $request
-
(Required) Full details about the request.
Return Return
(array) The Message data for the REST response.
Source Source
File: bp-messages/classes/class-bp-rest-messages-endpoint.php
public function prepare_message_for_response( $message, $request ) { $data = array( 'id' => (int) $message->id, 'thread_id' => (int) $message->thread_id, 'sender_id' => (int) $message->sender_id, 'subject' => array( 'raw' => $message->subject, 'rendered' => apply_filters( 'bp_get_message_thread_subject', wp_staticize_emoji( $message->subject ) ), ), 'message' => array( 'raw' => $message->message, 'rendered' => apply_filters( 'bp_get_the_thread_message_content', wp_staticize_emoji( $message->message ) ), ), 'date_sent' => bp_rest_prepare_date_response( $message->date_sent ), ); if ( bp_is_active( 'messages', 'star' ) ) { $user_id = bp_loggedin_user_id(); if ( isset( $request['user_id'] ) && $request['user_id'] ) { $user_id = (int) $request['user_id']; } $data['is_starred'] = bp_messages_is_message_starred( $data['id'], $user_id ); } // Add REST Fields (BP Messages meta) data. $data = $this->add_additional_fields_to_object( $data, $request ); /** * Filter a message value returned from the API. * * @since 5.0.0 * * @param array $data The message value for the REST response. * @param BP_Messages_Message $message The Message object. * @param WP_REST_Request $request Request used to generate the response. */ return apply_filters( 'bp_rest_message_prepare_value', $data, $message, $request ); }
Changelog Changelog
Version | Description |
---|---|
5.0.0 | Introduced. |