BP_REST_Members_Details_Endpoint::get_item_schema()

Get the members details schema, conforming to JSON Schema.

Description

Return

(array)

Source

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

574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
public function get_item_schema() {
    $schema = array(
        '$schema'    => 'http://json-schema.org/draft-04/schema#',
        'title'      => 'bp_members_details',
        'type'       => 'object',
        'properties' => array(
            'tabs'          => array(
                'context'     => array( 'embed', 'view' ),
                'description' => __( 'Members directory tabs.', 'buddyboss' ),
                'type'        => 'object',
                'readonly'    => true,
                'items'       => array(
                    'type' => 'array',
                ),
            ),
            'order_options' => array(
                'context'     => array( 'embed', 'view' ),
                'description' => __( 'Members order by options.', 'buddyboss' ),
                'type'        => 'array',
                'readonly'    => true,
            ),
        ),
    );
 
    /**
     * Filters the members details schema.
     *
     * @param array $schema The endpoint schema.
     */
    return apply_filters( 'bp_rest_members_schema', $this->add_additional_fields_schema( $schema ) );
}

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.