WP_REST_Global_Styles_Controller::get_item_schema(): array

Retrieves the global styles type’ schema, conforming to JSON Schema.


Return

array Item schema data.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php. View all references

public function get_item_schema() {
	if ( $this->schema ) {
		return $this->add_additional_fields_schema( $this->schema );
	}

	$schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => $this->post_type,
		'type'       => 'object',
		'properties' => array(
			'id'       => array(
				'description' => __( 'ID of global styles config.' ),
				'type'        => 'string',
				'context'     => array( 'embed', 'view', 'edit' ),
				'readonly'    => true,
			),
			'styles'   => array(
				'description' => __( 'Global styles.' ),
				'type'        => array( 'object' ),
				'context'     => array( 'view', 'edit' ),
			),
			'settings' => array(
				'description' => __( 'Global settings.' ),
				'type'        => array( 'object' ),
				'context'     => array( 'view', 'edit' ),
			),
			'title'    => array(
				'description' => __( 'Title of the global styles variation.' ),
				'type'        => array( 'object', 'string' ),
				'default'     => '',
				'context'     => array( 'embed', 'view', 'edit' ),
				'properties'  => array(
					'raw'      => array(
						'description' => __( 'Title for the global styles variation, as it exists in the database.' ),
						'type'        => 'string',
						'context'     => array( 'view', 'edit', 'embed' ),
					),
					'rendered' => array(
						'description' => __( 'HTML title for the post, transformed for display.' ),
						'type'        => 'string',
						'context'     => array( 'view', 'edit', 'embed' ),
						'readonly'    => true,
					),
				),
			),
		),
	);

	$this->schema = $schema;

	return $this->add_additional_fields_schema( $this->schema );
}


Top ↑

Changelog

Changelog
Version Description
5.9.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.