BP_REST_Friends_Endpoint::get_item( WP_REST_Request $request )

Retrieve single friendship.

Description

Parameters

$request: (Required) Full data about the request.

Return

(WP_REST_Response) | WP_Error

Source

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

public function get_item( $request ) {
 
    // Get friendship object.
    $friendship = $this->get_friendship_object( $request['id'] );
 
    if ( ! $friendship || empty( $friendship->id ) ) {
        return new WP_Error(
            'bp_rest_invalid_id',
            __( 'Invalid friendship ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    $retval = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $friendship, $request )
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires before a friendship is retrieved via the REST API.
     *
     * @param BP_Friends_Friendship $friendship The friendship object.
     * @param WP_REST_Response      $response   The response data.
     * @param WP_REST_Request       $request    The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_friends_get_item', $friendship, $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-friends/classes/class-bp-rest-friends-endpoint.php: BP_REST_Friends_Endpoint::get_friendship_object()	Get friendship object.
bp-friends/classes/class-bp-rest-friends-endpoint.php: BP_REST_Friends_Endpoint::prepare_item_for_response()	Prepares friendship data to return as an object.
bp-friends/classes/class-bp-rest-friends-endpoint.php: bp_rest_friends_get_item	Fires before a friendship is retrieved via the REST API.

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