BP_REST_Media_Endpoint::get_item_schema()
Get the media schema, conforming to JSON Schema.
Description
Return
(array)
Source
File: bp-media/classes/class-bp-rest-media-endpoint.php
public function get_item_schema() {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'bp_media',
'type' => 'object',
'properties' => array(
'id' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'A unique numeric ID for the Media.', 'buddyboss' ),
'readonly' => true,
'type' => 'integer',
),
'blog_id' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Current Site ID.', 'buddyboss' ),
'readonly' => true,
'type' => 'integer',
),
'attachment_id' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Unique identifier for the media object.', 'buddyboss' ),
'readonly' => true,
'type' => 'integer',
),
'user_id' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'The ID for the author of the media.', 'buddyboss' ),
'readonly' => true,
'type' => 'integer',
),
'title' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'The Media title.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
),
'album_id' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'A unique numeric ID for the Album.', 'buddyboss' ),
'readonly' => true,
'type' => 'integer',
),
'group_id' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'A unique numeric ID for the Group.', 'buddyboss' ),
'readonly' => true,
'type' => 'integer',
),
'activity_id' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'A unique numeric ID for the activity.', 'buddyboss' ),
'readonly' => true,
'type' => 'integer',
),
'privacy' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Privacy of the media.', 'buddyboss' ),
'enum' => array( 'public', 'loggedin', 'onlyme', 'friends', 'grouponly', 'message' ),
'readonly' => true,
'type' => 'string',
),
'menu_order' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Order of the item.', 'buddyboss' ),
'readonly' => true,
'type' => 'integer',
),
'date_created' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'The date the media was created, in the site\'s timezone.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
'format' => 'date-time',
),
'attachment_data' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Wordpress Media Data.', 'buddyboss' ),
'readonly' => true,
'type' => 'object',
'properties' => array(
'full' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Media URL with full image size.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
),
'thumb' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Media URL with thumbnail image size.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
),
'activity_thumb' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Media URL for the activity image size.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
),
'meta' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'Meta items for the media.', 'buddyboss' ),
'readonly' => true,
'type' => 'object',
),
),
),
'user_email' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'The user\'s email id to create a media.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
),
'user_nicename' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'The User\'s nice name to create a media.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
),
'user_login' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'The User\'s login name to create a media.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
),
'display_name' => array(
'context' => array( 'embed', 'view', 'edit' ),
'description' => __( 'The User\'s display name to create a media.', 'buddyboss' ),
'readonly' => true,
'type' => 'string',
),
),
);
/**
* Filters the media schema.
*
* @param array $schema The endpoint schema.
*/
return apply_filters( 'bp_rest_media_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.