BP_REST_Messages_Endpoint::prepare_recipient_for_response( object $recipient, WP_REST_Request $request )
Prepares recipient data for the REST response.
Description Description
Parameters Parameters
- $recipient
-
(Required) The recipient object.
- $request
-
(Required) Full details about the request.
Return Return
(array) The recipient data for the REST response.
Source Source
File: bp-messages/classes/class-bp-rest-messages-endpoint.php
public function prepare_recipient_for_response( $recipient, $request ) {
$data = array(
'id' => (int) $recipient->id,
'user_id' => (int) $recipient->user_id,
'user_link' => esc_url( bp_core_get_user_domain( $recipient->user_id ) ),
);
// Fetch the user avatar urls (Full & thumb).
if ( true === buddypress()->avatar->show_avatars ) {
foreach ( array( 'full', 'thumb' ) as $type ) {
$data['user_avatars'][ $type ] = bp_core_fetch_avatar(
array(
'item_id' => $recipient->user_id,
'html' => false,
'type' => $type,
)
);
}
}
$data = array_merge(
$data,
array(
'thread_id' => (int) $recipient->thread_id,
'unread_count' => (int) $recipient->unread_count,
'sender_only' => (int) $recipient->sender_only,
'is_deleted' => (int) $recipient->is_deleted,
)
);
/**
* Filter a recipient value returned from the API.
*
* @since 5.0.0
*
* @param array $data The recipient value for the REST response.
* @param object $recipient The recipient object.
* @param WP_REST_Request $request Request used to generate the response.
*/
return apply_filters( 'bp_rest_messages_prepare_recipient_value', $data, $recipient, $request );
}
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |