WP_REST_Revisions_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 8

Every hook that fires from inside WP_REST_Revisions_Controller, in the order it appears in the class, grouped by the method that fires it.

Properties · 4

$parent_post_typestringprivate

Parent post type.

$metaWP_REST_Post_Meta_Fieldsprotected

Instance of a revision meta fields object.

$parent_controllerWP_REST_Controllerprivate

Parent controller.

$parent_basestringprivate

The base of the parent controller's route.

Methods · 17

• __construct()Constructor.
• register_routes()Registers the routes for revisions based on post types supporting revisions.
• get_parent()Get the parent post, if the ID is valid.
• get_items_permissions_check()Checks if a given request has access to get revisions.
• get_revision()Get the revision, if the ID is valid.
• get_items()Gets a collection of revisions.
• get_item_permissions_check()Checks if a given request has access to get a specific revision.
• get_item()Retrieves one revision from the collection.
• delete_item_permissions_check()Checks if a given request has access to delete a revision.
• delete_item()Deletes a single revision.
• prepare_items_query()Determines the allowed query_vars for a get_items() response and prepares them for WP_Query.
• prepare_item_for_response()Prepares the revision for the REST response.
• restore_post_data()Restores the global post to its previous value after preparing a revision.
• prepare_date_response()Checks the post_date_gmt or modified_gmt and prepare any post or modified date for single post output.
• get_item_schema()Retrieves the revision's schema, conforming to JSON Schema.
• get_collection_params()Retrieves the query params for collections.
• prepare_excerpt_response()Checks the post excerpt and prepare it for single post output.

Source code

View on Trac ↗View on GitHub ↗

17class WP_REST_Revisions_Controller extends WP_REST_Controller {18 19	/**20	 * Parent post type.21	 *22	 * @since 4.7.023	 * @var string24	 */25	private $parent_post_type;26 27	/**28	 * Instance of a revision meta fields object.29	 *30	 * @since 6.4.031	 * @var WP_REST_Post_Meta_Fields32	 */33	protected $meta;34 35	/**36	 * Parent controller.37	 *38	 * @since 4.7.039	 * @var WP_REST_Controller40	 */41	private $parent_controller;42 43	/**44	 * The base of the parent controller's route.45	 *46	 * @since 4.7.047	 * @var string48	 */49	private $parent_base;50 51	/**52	 * Constructor.53	 *54	 * @since 4.7.055	 *56	 * @param string $parent_post_type Post type of the parent.57	 */58	public function __construct( $parent_post_type ) {59		$this->parent_post_type = $parent_post_type;60		$post_type_object       = get_post_type_object( $parent_post_type );61		$parent_controller      = $post_type_object->get_rest_controller();62 63		if ( ! $parent_controller ) {64			$parent_controller = new WP_REST_Posts_Controller( $parent_post_type );65		}66 67		$this->parent_controller = $parent_controller;68		$this->rest_base         = 'revisions';69		$this->parent_base       = ! empty( $post_type_object->rest_base ) ? $post_type_object->rest_base : $post_type_object->name;70		$this->namespace         = ! empty( $post_type_object->rest_namespace ) ? $post_type_object->rest_namespace : 'wp/v2';71		$this->meta              = new WP_REST_Post_Meta_Fields( $parent_post_type );72	}73 74	/**75	 * Registers the routes for revisions based on post types supporting revisions.76	 *77	 * @since 4.7.078	 *79	 * @see register_rest_route()80	 */81	public function register_routes() {82 83		register_rest_route(84			$this->namespace,85			'/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base,86			array(87				'args'   => array(88					'parent' => array(89						'description' => __( 'The ID for the parent of the revision.' ),90						'type'        => 'integer',91					),92				),93				array(94					'methods'             => WP_REST_Server::READABLE,95					'callback'            => array( $this, 'get_items' ),96					'permission_callback' => array( $this, 'get_items_permissions_check' ),

Changelog

Introduced in 4.7.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.