BP_REST_Topics_Actions_Endpoint::get_dropdown_item_schema()
Get the forums schema, conforming to JSON Schema.
Description
Return
(array)
Source
File: bp-forums/classes/class-bp-rest-topics-actions-endpoint.php
public function get_dropdown_item_schema() {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'topics_dropdown',
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Unique identifier for the topic.', 'buddyboss' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'description' => __( 'The title of the topic.', 'buddyboss' ),
'context' => array( 'view', 'edit' ),
'type' => 'object',
'properties' => array(
'raw' => array(
'description' => __( 'Content for the title of the topic, as it exists in the database.', 'buddyboss' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'rendered' => array(
'description' => __( 'The title of the topic, transformed for display.', 'buddyboss' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
),
);
/**
* Filters the topic dropdown schema.
*
* @param string $schema The endpoint schema.
*/
return apply_filters( 'bp_rest_topic_dropdown_schema', $this->add_additional_fields_schema( $schema ) );
}
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.