WP_REST_Pattern_Directory_Controller::get_item_schema(): array

Retrieves the block pattern’s schema, conforming to JSON Schema.


Return

array Item schema data.


Top ↑

Source

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

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

	$this->schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => 'pattern-directory-item',
		'type'       => 'object',
		'properties' => array(
			'id'             => array(
				'description' => __( 'The pattern ID.' ),
				'type'        => 'integer',
				'minimum'     => 1,
				'context'     => array( 'view', 'edit', 'embed' ),
			),

			'title'          => array(
				'description' => __( 'The pattern title, in human readable format.' ),
				'type'        => 'string',
				'minLength'   => 1,
				'context'     => array( 'view', 'edit', 'embed' ),
			),

			'content'        => array(
				'description' => __( 'The pattern content.' ),
				'type'        => 'string',
				'minLength'   => 1,
				'context'     => array( 'view', 'edit', 'embed' ),
			),

			'categories'     => array(
				'description' => __( "The pattern's category slugs." ),
				'type'        => 'array',
				'uniqueItems' => true,
				'items'       => array( 'type' => 'string' ),
				'context'     => array( 'view', 'edit', 'embed' ),
			),

			'keywords'       => array(
				'description' => __( "The pattern's keywords." ),
				'type'        => 'array',
				'uniqueItems' => true,
				'items'       => array( 'type' => 'string' ),
				'context'     => array( 'view', 'edit', 'embed' ),
			),

			'description'    => array(
				'description' => __( 'A description of the pattern.' ),
				'type'        => 'string',
				'minLength'   => 1,
				'context'     => array( 'view', 'edit', 'embed' ),
			),

			'viewport_width' => array(
				'description' => __( 'The preferred width of the viewport when previewing a pattern, in pixels.' ),
				'type'        => 'integer',
				'context'     => array( 'view', 'edit', 'embed' ),
			),
		),
	);

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


Top ↑

Changelog

Changelog
Version Description
5.8.0 Introduced.

Top ↑

User Contributed Notes

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