Contents

Code Reference Classes BP_REST_XProfile_Update_Endpoint BP_REST_XProfile_Update_Endpoint::get_item_schema()

BP_REST_XProfile_Update_Endpoint::get_item_schema()

Get the XProfile update schema, conforming to JSON Schema.

Description

Return

(array)

Source

File: bp-xprofile/classes/class-bp-rest-xprofile-update-endpoint.php

253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
public function get_item_schema() {
 
    $schema = array(
        '$schema'    => 'http://json-schema.org/draft-04/schema#',
        'title'      => 'bp_xprofile_update',
        'type'       => 'object',
        'properties' => array(
            'updated' => array(
                'context'     => array( 'edit' ),
                'description' => __( 'Whether fields updated or giving an error.', 'buddyboss' ),
                'readonly'    => true,
                'type'        => 'string',
            ),
            'data'    => array(
                'context'     => array( 'edit' ),
                'description' => __( 'Object of groups.', 'buddyboss' ),
                'readonly'    => true,
                'type'        => 'object',
                'properties'  => $this->group_fields_endpoint->get_item_schema()['properties'],
            ),
        ),
    );
 
    /**
     * Filters the xprofile field group schema.
     *
     * @param array $schema The endpoint schema.
     */
    return apply_filters( 'bp_rest_xprofile_update_schema', $schema );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-xprofile/classes/class-bp-rest-xprofile-update-endpoint.php: bp_rest_xprofile_update_schema

Filters the xprofile field group 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.