BP_REST_Group_Invites_Endpoint::prepare_links( BP_Invitation $invite )

Prepare links for the request.

Description

Parameters

$invite: (Required) Invite object.

Return

(array) Links for the given plugin.

Source

File: bp-groups/classes/class-bp-rest-group-invites-endpoint.php

protected function prepare_links( $invite ) {
    $base = sprintf( '/%s/%s/', $this->namespace, $this->rest_base );
    $url  = $base . $invite->id;
 
    // Entity meta.
    $links = array(
        'self'       => array(
            'href' => rest_url( $url ),
        ),
        'collection' => array(
            'href' => rest_url( $base ),
        ),
        'user'       => array(
            'href'       => rest_url( bp_rest_get_user_url( $invite->user_id ) ),
            'embeddable' => true,
        ),
    );
 
    /**
     * Filter links prepared for the REST response.
     *
     * @param array    $links  The prepared links of the REST response.
     * @param stdClass $invite Invite object.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_group_invites_prepare_links', $links, $invite );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/classes/class-bp-rest-group-invites-endpoint.php: bp_rest_group_invites_prepare_links	Filter links prepared for the REST response.
bp-core/bp-core-rest-api.php: bp_rest_get_user_url()	Get user URL.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-group-invites-endpoint.php: BP_REST_Group_Invites_Endpoint::prepare_item_for_response()	Prepares group invitation data to return as an object.

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