WP_REST_Revisions_Controller::register_routes()

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


Description

Top ↑

See also


Top ↑

Source

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

public function register_routes() {

	register_rest_route(
		$this->namespace,
		'/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base,
		array(
			'args'   => array(
				'parent' => array(
					'description' => __( 'The ID for the parent of the revision.' ),
					'type'        => 'integer',
				),
			),
			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,
		'/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base . '/(?P<id>[\d]+)',
		array(
			'args'   => array(
				'parent' => array(
					'description' => __( 'The ID for the parent of the revision.' ),
					'type'        => 'integer',
				),
				'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' ),
		)
	);

}


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

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