--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/wp/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php Wed Sep 21 18:19:35 2022 +0200
@@ -0,0 +1,600 @@
+<?php
+/**
+ * REST API: WP_REST_Templates_Controller class
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 5.8.0
+ */
+
+/**
+ * Base Templates REST API Controller.
+ *
+ * @since 5.8.0
+ *
+ * @see WP_REST_Controller
+ */
+class WP_REST_Templates_Controller extends WP_REST_Controller {
+
+ /**
+ * Post type.
+ *
+ * @since 5.8.0
+ * @var string
+ */
+ protected $post_type;
+
+ /**
+ * Constructor.
+ *
+ * @since 5.8.0
+ *
+ * @param string $post_type Post type.
+ */
+ public function __construct( $post_type ) {
+ $this->post_type = $post_type;
+ $this->namespace = 'wp/v2';
+ $obj = get_post_type_object( $post_type );
+ $this->rest_base = ! empty( $obj->rest_base ) ? $obj->rest_base : $obj->name;
+ }
+
+ /**
+ * Registers the controllers routes.
+ *
+ * @since 5.8.0
+ */
+ public function register_routes() {
+ // Lists all templates.
+ register_rest_route(
+ $this->namespace,
+ '/' . $this->rest_base,
+ array(
+ array(
+ 'methods' => WP_REST_Server::READABLE,
+ 'callback' => array( $this, 'get_items' ),
+ 'permission_callback' => array( $this, 'get_items_permissions_check' ),
+ 'args' => $this->get_collection_params(),
+ ),
+ array(
+ 'methods' => WP_REST_Server::CREATABLE,
+ 'callback' => array( $this, 'create_item' ),
+ 'permission_callback' => array( $this, 'create_item_permissions_check' ),
+ 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+ ),
+ 'schema' => array( $this, 'get_public_item_schema' ),
+ )
+ );
+
+ // Lists/updates a single template based on the given id.
+ register_rest_route(
+ $this->namespace,
+ '/' . $this->rest_base . '/(?P<id>[\/\w-]+)',
+ array(
+ array(
+ 'methods' => WP_REST_Server::READABLE,
+ 'callback' => array( $this, 'get_item' ),
+ 'permission_callback' => array( $this, 'get_item_permissions_check' ),
+ 'args' => array(
+ 'id' => array(
+ 'description' => __( 'The id of a template' ),
+ 'type' => 'string',
+ ),
+ ),
+ ),
+ array(
+ 'methods' => WP_REST_Server::EDITABLE,
+ 'callback' => array( $this, 'update_item' ),
+ 'permission_callback' => array( $this, 'update_item_permissions_check' ),
+ 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+ ),
+ 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' => __( 'Whether to bypass Trash and force deletion.' ),
+ ),
+ ),
+ ),
+ 'schema' => array( $this, 'get_public_item_schema' ),
+ )
+ );
+ }
+
+ /**
+ * Checks if the user has permissions to make the request.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
+ */
+ protected function permissions_check( $request ) {
+ // Verify if the current user has edit_theme_options capability.
+ // This capability is required to edit/view/delete templates.
+ if ( ! current_user_can( 'edit_theme_options' ) ) {
+ return new WP_Error(
+ 'rest_cannot_manage_templates',
+ __( 'Sorry, you are not allowed to access the templates on this site.' ),
+ array(
+ 'status' => rest_authorization_required_code(),
+ )
+ );
+ }
+
+ return true;
+ }
+
+ /**
+ * Checks if a given request has access to read templates.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
+ */
+ public function get_items_permissions_check( $request ) {
+ return $this->permissions_check( $request );
+ }
+
+ /**
+ * Returns a list of templates.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request The request instance.
+ * @return WP_REST_Response
+ */
+ public function get_items( $request ) {
+ $query = array();
+ if ( isset( $request['wp_id'] ) ) {
+ $query['wp_id'] = $request['wp_id'];
+ }
+ if ( isset( $request['area'] ) ) {
+ $query['area'] = $request['area'];
+ }
+
+ $templates = array();
+ foreach ( get_block_templates( $query, $this->post_type ) as $template ) {
+ $data = $this->prepare_item_for_response( $template, $request );
+ $templates[] = $this->prepare_response_for_collection( $data );
+ }
+
+ return rest_ensure_response( $templates );
+ }
+
+ /**
+ * Checks if a given request has access to read a single template.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise.
+ */
+ public function get_item_permissions_check( $request ) {
+ return $this->permissions_check( $request );
+ }
+
+ /**
+ * Returns the given template
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request The request instance.
+ * @return WP_REST_Response|WP_Error
+ */
+ public function get_item( $request ) {
+ $template = get_block_template( $request['id'], $this->post_type );
+
+ if ( ! $template ) {
+ return new WP_Error( 'rest_template_not_found', __( 'No templates exist with that id.' ), array( 'status' => 404 ) );
+ }
+
+ return $this->prepare_item_for_response( $template, $request );
+ }
+
+ /**
+ * Checks if a given request has access to write a single template.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has write access for the item, WP_Error object otherwise.
+ */
+ public function update_item_permissions_check( $request ) {
+ return $this->permissions_check( $request );
+ }
+
+ /**
+ * Updates a single template.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function update_item( $request ) {
+ $template = get_block_template( $request['id'], $this->post_type );
+ if ( ! $template ) {
+ return new WP_Error( 'rest_template_not_found', __( 'No templates exist with that id.' ), array( 'status' => 404 ) );
+ }
+
+ $changes = $this->prepare_item_for_database( $request );
+
+ if ( 'custom' === $template->source ) {
+ $result = wp_update_post( wp_slash( (array) $changes ), true );
+ } else {
+ $result = wp_insert_post( wp_slash( (array) $changes ), true );
+ }
+ if ( is_wp_error( $result ) ) {
+ return $result;
+ }
+
+ $template = get_block_template( $request['id'], $this->post_type );
+ $fields_update = $this->update_additional_fields_for_object( $template, $request );
+ if ( is_wp_error( $fields_update ) ) {
+ return $fields_update;
+ }
+
+ return $this->prepare_item_for_response(
+ get_block_template( $request['id'], $this->post_type ),
+ $request
+ );
+ }
+
+ /**
+ * Checks if a given request has access to create a template.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has access to create items, WP_Error object otherwise.
+ */
+ public function create_item_permissions_check( $request ) {
+ return $this->permissions_check( $request );
+ }
+
+ /**
+ * Creates a single template.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function create_item( $request ) {
+ $changes = $this->prepare_item_for_database( $request );
+ $changes->post_name = $request['slug'];
+ $result = wp_insert_post( wp_slash( (array) $changes ), true );
+ if ( is_wp_error( $result ) ) {
+ return $result;
+ }
+ $posts = get_block_templates( array( 'wp_id' => $result ), $this->post_type );
+ if ( ! count( $posts ) ) {
+ return new WP_Error( 'rest_template_insert_error', __( 'No templates exist with that id.' ) );
+ }
+ $id = $posts[0]->id;
+ $template = get_block_template( $id, $this->post_type );
+ $fields_update = $this->update_additional_fields_for_object( $template, $request );
+ if ( is_wp_error( $fields_update ) ) {
+ return $fields_update;
+ }
+
+ return $this->prepare_item_for_response(
+ get_block_template( $id, $this->post_type ),
+ $request
+ );
+ }
+
+ /**
+ * Checks if a given request has access to delete a single template.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has delete access for the item, WP_Error object otherwise.
+ */
+ public function delete_item_permissions_check( $request ) {
+ return $this->permissions_check( $request );
+ }
+
+ /**
+ * Deletes a single template.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function delete_item( $request ) {
+ $template = get_block_template( $request['id'], $this->post_type );
+ if ( ! $template ) {
+ return new WP_Error( 'rest_template_not_found', __( 'No templates exist with that id.' ), array( 'status' => 404 ) );
+ }
+ if ( 'custom' !== $template->source ) {
+ return new WP_Error( 'rest_invalid_template', __( 'Templates based on theme files can\'t be removed.' ), array( 'status' => 400 ) );
+ }
+
+ $id = $template->wp_id;
+ $force = (bool) $request['force'];
+
+ // If we're forcing, then delete permanently.
+ if ( $force ) {
+ $previous = $this->prepare_item_for_response( $template, $request );
+ wp_delete_post( $id, true );
+ $response = new WP_REST_Response();
+ $response->set_data(
+ array(
+ 'deleted' => true,
+ 'previous' => $previous->get_data(),
+ )
+ );
+
+ return $response;
+ }
+
+ // Otherwise, only trash if we haven't already.
+ if ( 'trash' === $template->status ) {
+ return new WP_Error(
+ 'rest_template_already_trashed',
+ __( 'The template has already been deleted.' ),
+ array( 'status' => 410 )
+ );
+ }
+
+ wp_trash_post( $id );
+ $template->status = 'trash';
+ return $this->prepare_item_for_response( $template, $request );
+ }
+
+ /**
+ * Prepares a single template for create or update.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_REST_Request $request Request object.
+ * @return stdClass Changes to pass to wp_update_post.
+ */
+ protected function prepare_item_for_database( $request ) {
+ $template = $request['id'] ? get_block_template( $request['id'], $this->post_type ) : null;
+ $changes = new stdClass();
+ if ( null === $template ) {
+ $changes->post_type = $this->post_type;
+ $changes->post_status = 'publish';
+ $changes->tax_input = array(
+ 'wp_theme' => isset( $request['theme'] ) ? $request['theme'] : wp_get_theme()->get_stylesheet(),
+ );
+ } elseif ( 'custom' !== $template->source ) {
+ $changes->post_name = $template->slug;
+ $changes->post_type = $this->post_type;
+ $changes->post_status = 'publish';
+ $changes->tax_input = array(
+ 'wp_theme' => $template->theme,
+ );
+ } else {
+ $changes->post_name = $template->slug;
+ $changes->ID = $template->wp_id;
+ $changes->post_status = 'publish';
+ }
+ if ( isset( $request['content'] ) ) {
+ $changes->post_content = $request['content'];
+ } elseif ( null !== $template && 'custom' !== $template->source ) {
+ $changes->post_content = $template->content;
+ }
+ if ( isset( $request['title'] ) ) {
+ $changes->post_title = $request['title'];
+ } elseif ( null !== $template && 'custom' !== $template->source ) {
+ $changes->post_title = $template->title;
+ }
+ if ( isset( $request['description'] ) ) {
+ $changes->post_excerpt = $request['description'];
+ } elseif ( null !== $template && 'custom' !== $template->source ) {
+ $changes->post_excerpt = $template->description;
+ }
+
+ return $changes;
+ }
+
+ /**
+ * Prepare a single template output for response
+ *
+ * @since 5.8.0
+ *
+ * @param WP_Block_Template $template Template instance.
+ * @param WP_REST_Request $request Request object.
+ * @return WP_REST_Response $data
+ */
+ public function prepare_item_for_response( $template, $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+ $result = array(
+ 'id' => $template->id,
+ 'theme' => $template->theme,
+ 'content' => array( 'raw' => $template->content ),
+ 'slug' => $template->slug,
+ 'source' => $template->source,
+ 'type' => $template->type,
+ 'description' => $template->description,
+ 'title' => array(
+ 'raw' => $template->title,
+ 'rendered' => $template->title,
+ ),
+ 'status' => $template->status,
+ 'wp_id' => $template->wp_id,
+ 'has_theme_file' => $template->has_theme_file,
+ );
+
+ if ( 'wp_template_part' === $template->type ) {
+ $result['area'] = $template->area;
+ }
+
+ $result = $this->add_additional_fields_to_object( $result, $request );
+
+ $response = rest_ensure_response( $result );
+ $links = $this->prepare_links( $template->id );
+ $response->add_links( $links );
+ if ( ! empty( $links['self']['href'] ) ) {
+ $actions = $this->get_available_actions();
+ $self = $links['self']['href'];
+ foreach ( $actions as $rel ) {
+ $response->add_link( $rel, $self );
+ }
+ }
+
+ return $response;
+ }
+
+
+ /**
+ * Prepares links for the request.
+ *
+ * @since 5.8.0
+ *
+ * @param integer $id ID.
+ * @return array Links for the given post.
+ */
+ protected function prepare_links( $id ) {
+ $base = sprintf( '%s/%s', $this->namespace, $this->rest_base );
+
+ $links = array(
+ 'self' => array(
+ 'href' => rest_url( trailingslashit( $base ) . $id ),
+ ),
+ 'collection' => array(
+ 'href' => rest_url( $base ),
+ ),
+ 'about' => array(
+ 'href' => rest_url( 'wp/v2/types/' . $this->post_type ),
+ ),
+ );
+
+ return $links;
+ }
+
+ /**
+ * Get the link relations available for the post and current user.
+ *
+ * @since 5.8.0
+ *
+ * @return array List of link relations.
+ */
+ protected function get_available_actions() {
+ $rels = array();
+
+ $post_type = get_post_type_object( $this->post_type );
+
+ if ( current_user_can( $post_type->cap->publish_posts ) ) {
+ $rels[] = 'https://api.w.org/action-publish';
+ }
+
+ if ( current_user_can( 'unfiltered_html' ) ) {
+ $rels[] = 'https://api.w.org/action-unfiltered-html';
+ }
+
+ return $rels;
+ }
+
+ /**
+ * Retrieves the query params for the posts collection.
+ *
+ * @since 5.8.0
+ *
+ * @return array Collection parameters.
+ */
+ public function get_collection_params() {
+ return array(
+ 'context' => $this->get_context_param(),
+ 'wp_id' => array(
+ 'description' => __( 'Limit to the specified post id.' ),
+ 'type' => 'integer',
+ ),
+ );
+ }
+
+ /**
+ * Retrieves the block type' schema, conforming to JSON Schema.
+ *
+ * @since 5.8.0
+ *
+ * @return array Item schema data.
+ */
+ public function get_item_schema() {
+ if ( $this->schema ) {
+ return $this->add_additional_fields_schema( $this->schema );
+ }
+
+ $schema = array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'title' => $this->post_type,
+ 'type' => 'object',
+ 'properties' => array(
+ 'id' => array(
+ 'description' => __( 'ID of template.' ),
+ 'type' => 'string',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'slug' => array(
+ 'description' => __( 'Unique slug identifying the template.' ),
+ 'type' => 'string',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ 'required' => true,
+ 'minLength' => 1,
+ 'pattern' => '[a-zA-Z_\-]+',
+ ),
+ 'theme' => array(
+ 'description' => __( 'Theme identifier for the template.' ),
+ 'type' => 'string',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ ),
+ 'source' => array(
+ 'description' => __( 'Source of template' ),
+ 'type' => 'string',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'content' => array(
+ 'description' => __( 'Content of template.' ),
+ 'type' => array( 'object', 'string' ),
+ 'default' => '',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ ),
+ 'title' => array(
+ 'description' => __( 'Title of template.' ),
+ 'type' => array( 'object', 'string' ),
+ 'default' => '',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ ),
+ 'description' => array(
+ 'description' => __( 'Description of template.' ),
+ 'type' => 'string',
+ 'default' => '',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ ),
+ 'status' => array(
+ 'description' => __( 'Status of template.' ),
+ 'type' => 'string',
+ 'default' => 'publish',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ ),
+ 'wp_id' => array(
+ 'description' => __( 'Post ID.' ),
+ 'type' => 'integer',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'has_theme_file' => array(
+ 'description' => __( 'Theme file exists.' ),
+ 'type' => 'bool',
+ 'context' => array( 'embed', 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ ),
+ );
+
+ $this->schema = $schema;
+
+ return $this->add_additional_fields_schema( $this->schema );
+ }
+}