Contents

Code Reference Classes BP_REST_Members_Endpoint BP_REST_Members_Endpoint::prepare_item_for_response()

BP_REST_Members_Endpoint::prepare_item_for_response( WP_User $user, WP_REST_Request $request )

Prepares a single user output for response.

Description

Parameters

$user

(Required) User object.

$request

(Required) Full details about the request.

Return

(WP_REST_Response)

Source

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

645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
public function prepare_item_for_response( $user, $request ) {
    $context  = ! empty( $request['context'] ) ? $request['context'] : 'view';
    $data     = $this->user_data( $user, $context );
    $data     = $this->add_additional_fields_to_object( $data, $request );
    $data     = $this->filter_response_by_context( $data, $context );
    $response = rest_ensure_response( $data );
 
    $response->add_links( $this->prepare_links( $user ) );
 
    /**
     * Filters user data returned from the API.
     *
     * @param WP_REST_Response $response The response object.
     * @param WP_REST_Request  $request  The request object.
     * @param WP_User          $user     WP_User object.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_members_prepare_value', $response, $request, $user );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

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.