WP_REST_Template_Revisions_Controller::register_routes │ public │ WP 6.4.0

Registers the routes for revisions based on post types supporting revisions.

Method of the class: WP_REST_Template_Revisions_Controller{}

No Hooks.

Returns

null. Nothing (null).

Usage

$WP_REST_Template_Revisions_Controller = new WP_REST_Template_Revisions_Controller();
$WP_REST_Template_Revisions_Controller->register_routes();

Notes

• See: register_rest_route()

Changelog

WP_REST_Template_Revisions_Controller::register_routes() WP REST Template Revisions Controller::register routes code ^{WP 6.9}

public function register_routes() {

	register_rest_route(
		$this->namespace,
		sprintf(
			'/%s/(?P<parent>%s%s)/%s',
			$this->parent_base,
			/*
			 * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.
			 * Excludes invalid directory name characters: `/:<>*?"|`.
			 */
			'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',
			// Matches the template name.
			'[\/\w%-]+',
			$this->rest_base
		),
		array(
			'args'   => array(
				'parent' => array(
					'description'       => __( 'The id of a template' ),
					'type'              => 'string',
					'sanitize_callback' => array( $this->parent_controller, '_sanitize_template_id' ),
				),
			),
			array(
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => array( $this, 'get_items' ),
				'permission_callback' => array( $this, 'get_items_permissions_check' ),
				'args'                => $this->get_collection_params(),
			),
			'schema' => array( $this, 'get_public_item_schema' ),
		)
	);

	register_rest_route(
		$this->namespace,
		sprintf(
			'/%s/(?P<parent>%s%s)/%s/%s',
			$this->parent_base,
			/*
			 * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.
			 * Excludes invalid directory name characters: `/:<>*?"|`.
			 */
			'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',
			// Matches the template name.
			'[\/\w%-]+',
			$this->rest_base,
			'(?P<id>[\d]+)'
		),
		array(
			'args'   => array(
				'parent' => array(
					'description'       => __( 'The id of a template' ),
					'type'              => 'string',
					'sanitize_callback' => array( $this->parent_controller, '_sanitize_template_id' ),
				),
				'id'     => array(
					'description' => __( 'Unique identifier for the revision.' ),
					'type'        => 'integer',
				),
			),
			array(
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => array( $this, 'get_item' ),
				'permission_callback' => array( $this, 'get_item_permissions_check' ),
				'args'                => array(
					'context' => $this->get_context_param( array( 'default' => 'view' ) ),
				),
			),
			array(
				'methods'             => WP_REST_Server::DELETABLE,
				'callback'            => array( $this, 'delete_item' ),
				'permission_callback' => array( $this, 'delete_item_permissions_check' ),
				'args'                => array(
					'force' => array(
						'type'        => 'boolean',
						'default'     => false,
						'description' => __( 'Required to be true, as revisions do not support trashing.' ),
					),
				),
			),
			'schema' => array( $this, 'get_public_item_schema' ),
		)
	);
}