WP_REST_Autosaves_Controller
- Since
- 5.0.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php:18
Core class used to access autosaves via the REST API.
Compatibility
- WordPress
- since 5.0.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Hooks and filters fired · 3
Every hook that fires from inside WP_REST_Autosaves_Controller, in the order it appears in the class, grouped by the method that fires it.
Properties · 4
$parent_post_typestringprivate- Parent post type.
$parent_controllerWP_REST_Controllerprivate- Parent post controller.
$revisions_controllerWP_REST_Revisions_Controllerprivate- Revision controller.
$parent_basestringprivate- The base of the parent controller's route.
Methods · 12
- __construct()Constructor.
- register_routes()Registers the routes for autosaves.
- get_parent()Get the parent post.
- get_items_permissions_check()Checks if a given request has access to get autosaves.
- create_item_permissions_check()Checks if a given request has access to create an autosave revision.
- create_item()Creates, updates or deletes an autosave revision.
- get_item()Get the autosave, if the ID is valid.
- get_items()Gets a collection of autosaves using wp_get_post_autosave.
- get_item_schema()Retrieves the autosave's schema, conforming to JSON Schema.
- create_post_autosave()Creates autosave for the specified post.
- prepare_item_for_response()Prepares the revision for the REST response.
- get_collection_params()Retrieves the query params for the autosaves collection.
Source code
class WP_REST_Autosaves_Controller extends WP_REST_Revisions_Controller { /** * Parent post type. * * @since 5.0.0 * @var string */ private $parent_post_type; /** * Parent post controller. * * @since 5.0.0 * @var WP_REST_Controller */ private $parent_controller; /** * Revision controller. * * @since 5.0.0 * @var WP_REST_Revisions_Controller */ private $revisions_controller; /** * The base of the parent controller's route. * * @since 5.0.0 * @var string */ private $parent_base; /** * Constructor. * * @since 5.0.0 * * @param string $parent_post_type Post type of the parent. */ public function __construct( $parent_post_type ) { $this->parent_post_type = $parent_post_type; $post_type_object = get_post_type_object( $parent_post_type ); $parent_controller = $post_type_object->get_rest_controller(); if ( ! $parent_controller ) { $parent_controller = new WP_REST_Posts_Controller( $parent_post_type ); } $this->parent_controller = $parent_controller; $revisions_controller = $post_type_object->get_revisions_rest_controller(); if ( ! $revisions_controller ) { $revisions_controller = new WP_REST_Revisions_Controller( $parent_post_type ); } $this->revisions_controller = $revisions_controller; $this->rest_base = 'autosaves'; $this->parent_base = ! empty( $post_type_object->rest_base ) ? $post_type_object->rest_base : $post_type_object->name; $this->namespace = ! empty( $post_type_object->rest_namespace ) ? $post_type_object->rest_namespace : 'wp/v2'; } /** * Registers the routes for autosaves. * * @since 5.0.0 * * @see register_rest_route() */ public function register_routes() { register_rest_route( $this->namespace, '/' . $this->parent_base . '/(?P<id>[\d]+)/' . $this->rest_base, array( 'args' => array( 'parent' => array( 'description' => __( 'The ID for the parent of the autosave.' ), 'type' => 'integer', ), ),Changelog
Introduced in 5.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-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.