Contents

Code Reference Classes BP_REST_Invites_Endpoint BP_REST_Invites_Endpoint::prepare_item_for_response()

BP_REST_Invites_Endpoint::prepare_item_for_response( WP_Post $item, WP_REST_Request $request )

Prepares Invite data for return as an object.

Description

Parameters

$item

(Required) bp-invite post object.

$request

(Required) Full details about the request.

Return

(WP_REST_Response)

Source

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

686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
public function prepare_item_for_response( $item, $request ) {
    $data = array(
        'id'             => $item->ID,
        'name'           => get_post_meta( $item->ID, '_bp_invitee_name', true ),
        'email'          => get_post_meta( $item->ID, '_bp_invitee_email', true ),
        'date'           => $this->prepare_date_response( $item->post_date_gmt, $item->post_date ),
        'date_gmt'       => $this->prepare_date_response( $item->post_date_gmt ),
        'status'         => '',
        'invitee-status' => (bool) get_post_meta( $item->ID, '_bp_invitee_status', true ),
        'revoke-invite'  => false,
    );
 
    if (
        function_exists( 'bp_allow_custom_registration' )
        && function_exists( 'bp_custom_register_page_url' )
        && bp_allow_custom_registration()
        && '' !== bp_custom_register_page_url()
    ) {
        $data['status'] = ( '1' === get_post_meta( $item->ID, '_bp_invitee_status', true ) ) ? __( 'Registered', 'buddyboss' ) : __( 'Invited', 'buddyboss' );
    } else {
        $data['status']        = ( '1' === get_post_meta( $item->ID, '_bp_invitee_status', true ) ) ? __( 'Registered', 'buddyboss' ) : __( 'Revoke Invite', 'buddyboss' );
        $data['revoke-invite'] = ( '1' === get_post_meta( $item->ID, '_bp_invitee_status', true ) ) ? false : true;
    }
 
    $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 invite value returned from the API.
     *
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request  $request  Request used to generate the response.
     * @param WP_Post          $item     bp-invite post object.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_invites_prepare_value', $response, $request, $item );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-invites/classes/class-bp-rest-invites-endpoint.php: BP_REST_Invites_Endpoint::prepare_date_response()

Check the post_date_gmt or modified_gmt and prepare any post or modified date for single post output.
bp-invites/classes/class-bp-rest-invites-endpoint.php: bp_rest_invites_prepare_value

Filter a invite value returned from the API.
bp-core/bp-core-options.php: bp_custom_register_page_url()

Register page URL.
bp-core/bp-core-options.php: bp_allow_custom_registration()

Allow custom registration.

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.