BP_REST_Signup_Endpoint::get_item( WP_REST_Request $request )

Retrieve single signup.

Description

Parameters

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

Return

(WP_REST_Response) | WP_Error

Source

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

public function get_item( $request ) {
    // Get signup.
    $signup = $this->get_signup_object( $request['id'] );
 
    $retval = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $signup, $request )
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires before a signup is retrieved via the REST API.
     *
     * @param BP_Signup        $signup   The signup 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_signup_get_item', $signup, $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-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::get_signup_object()	Get signup object.
bp-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::prepare_item_for_response()	Prepares signup to return as an object.
bp-members/classes/class-bp-rest-signup-endpoint.php: bp_rest_signup_get_item	Fires before a signup 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

Description

Parameters

Return

Source

Changelog

Related

Uses

Questions?