BP_REST_Attachments_Blog_Avatar_Endpoint::prepare_item_for_response( stdClass $avatar, WP_REST_Request $request )

Prepares avatar data to return as an object.

Description

Parameters

$avatar: (Required) Avatar object.
$request: (Required) Full details about the request.

Return

(WP_REST_Response)

Source

File: bp-blogs/classes/class-bp-rest-attachments-blog-avatar-endpoint.php

public function prepare_item_for_response( $avatar, $request ) {
    $data = array(
        'full'  => $avatar->full,
        'thumb' => $avatar->thumb,
    );
 
    $context  = ! empty( $request['context'] ) ? $request['context'] : 'view';
    $data     = $this->add_additional_fields_to_object( $data, $request );
    $data     = $this->filter_response_by_context( $data, $context );
    $response = rest_ensure_response( $data );
 
    /**
     * Filter a blog avatar value returned from the API.
     *
     * @since 0.1.0
     *
     * @param WP_REST_Response  $response Response.
     * @param WP_REST_Request   $request  Request used to generate the response.
     * @param object            $avatar   Avatar object.
     */
    return apply_filters( 'bp_rest_attachments_blog_avatar_prepare_value', $response, $request, $avatar );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-blogs/classes/class-bp-rest-attachments-blog-avatar-endpoint.php: bp_rest_attachments_blog_avatar_prepare_value	Filter a blog avatar value returned from the API.

Used By
Used By	Description
bp-blogs/classes/class-bp-rest-attachments-blog-avatar-endpoint.php: BP_REST_Attachments_Blog_Avatar_Endpoint::get_item()	Fetch an existing blog avatar.

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