Contents

Code Reference Classes BP_REST_Activity_Comment_Endpoint BP_REST_Activity_Comment_Endpoint::get_item_schema()

BP_REST_Activity_Comment_Endpoint::get_item_schema()

Get the plugin schema, conforming to JSON Schema.

Description

Return

(array)

Source

File: bp-activity/classes/class-bp-rest-activity-comment-endpoint.php

353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
public function get_item_schema() {
    $schema = array(
        '$schema'    => 'http://json-schema.org/draft-04/schema#',
        'title'      => 'activity_comments',
        'type'       => 'object',
        'properties' => array(
            'created'  => array(
                'context'     => array( 'embed', 'edit' ),
                'description' => __( 'Whether the comment created or not.', 'buddyboss' ),
                'type'        => 'boolean',
                'readonly'    => true,
            ),
            'comments' => array(
                'context'     => array( 'embed', 'view', 'edit' ),
                'description' => __( 'A list of comments for activity.', 'buddyboss' ),
                'type'        => 'array',
                'readonly'    => true,
            ),
        ),
    );
 
    /**
     * Filters the activity details schema.
     *
     * @param string $schema The endpoint schema.
     */
    return apply_filters( 'bp_rest_activity_comment_details_schema', $this->add_additional_fields_schema( $schema ) );
}

Expand full source code Collapse full source code

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.