WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_View_Config_Controller::get_list_layout_schema()

WP_REST_View_Config_Controller::get_list_layout_schema(): array

In this article

Back to top

Returns the layout schema for list-type views (ViewList, ViewActivity).

Return

array Schema for a list layout object.

Source

protected function get_list_layout_schema() {
	return array(
		'type'       => 'object',
		'properties' => array(
			'density' => array(
				'type' => 'string',
				'enum' => array( 'compact', 'balanced', 'comfortable' ),
			),
		),
	);
}

View all references View on Trac View on GitHub

Used byDescription
WP_REST_View_Config_Controller::get_item_schema()wp-includes/rest-api/endpoints/class-wp-rest-view-config-controller.php

Retrieves the item’s schema, conforming to JSON Schema.

WP_REST_View_Config_Controller::get_combined_layout_schema()wp-includes/rest-api/endpoints/class-wp-rest-view-config-controller.php

Returns a combined layout schema that accepts properties from all view types.

Changelog

VersionDescription
7.1.0Introduced.

User Contributed Notes

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