Contents

Code Reference Classes BP_REST_Document_Details_Endpoint BP_REST_Document_Details_Endpoint::get_item_schema()

BP_REST_Document_Details_Endpoint::get_item_schema()

Get the document details schema, conforming to JSON Schema.

Description

Return

(array)

Source

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

113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
public function get_item_schema() {
    $schema = array(
        '$schema'    => 'http://json-schema.org/draft-04/schema#',
        'title'      => 'bp_document_details',
        'type'       => 'object',
        'properties' => array(
            'tabs'    => array(
                'context'     => array( 'embed', 'view' ),
                'description' => __( 'Documents directory tabs.', 'buddyboss' ),
                'type'        => 'object',
                'readonly'    => true,
                'items'       => array(
                    'type' => 'array',
                ),
            ),
            'privacy' => array(
                'context'     => array( 'embed', 'view' ),
                'description' => __( 'Document privacy.', 'buddyboss' ),
                'type'        => 'object',
                'readonly'    => true,
            ),
        ),
    );
 
    /**
     * Filters the document details schema.
     *
     * @param array $schema The endpoint schema.
     */
    return apply_filters( 'bp_rest_document_details_schema', $this->add_additional_fields_schema( $schema ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-document/classes/class-bp-rest-document-details-endpoint.php: bp_rest_document_details_schema

Filters the document details schema.

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.