BP_REST_Components_Endpoint::get_item_schema()
Get the components schema, conforming to JSON Schema.
Description Description
Return Return
(array)
Source Source
File: bp-core/classes/class-bp-rest-components-endpoint.php
public function get_item_schema() { $schema = array( '$schema' => 'http://json-schema.org/draft-04/schema#', 'title' => 'bp_components', 'type' => 'object', 'properties' => array( 'name' => array( 'context' => array( 'view', 'edit' ), 'description' => __( 'Name of the object.', 'buddypress' ), 'type' => 'string', 'arg_options' => array( 'sanitize_callback' => 'sanitize_key', ), ), 'status' => array( 'context' => array( 'view', 'edit' ), 'description' => __( 'Whether the object is active or inactive.', 'buddypress' ), 'type' => 'string', 'enum' => array( 'active', 'inactive' ), 'arg_options' => array( 'sanitize_callback' => 'sanitize_key', ), ), 'title' => array( 'context' => array( 'view', 'edit' ), 'description' => __( 'HTML title of the object.', 'buddypress' ), 'type' => 'string', 'arg_options' => array( 'sanitize_callback' => 'sanitize_text_field', ), ), 'description' => array( 'context' => array( 'view', 'edit' ), 'description' => __( 'HTML description of the object.', 'buddypress' ), 'type' => 'string', 'arg_options' => array( 'sanitize_callback' => 'sanitize_text_field', ), ), ), ); /** * Filters the components schema. * * @param string $schema The endpoint schema. */ return apply_filters( 'bp_rest_components_schema', $this->add_additional_fields_schema( $schema ) ); }
Changelog Changelog
Version | Description |
---|---|
5.0.0 | Introduced. |