WP_REST_Templates_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 4

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

Properties · 1

$post_typestringprotected

Post type.

Methods · 23

• __construct()Constructor.
• register_routes()Registers the controllers routes.
• get_template_fallback()Returns the fallback template for the given slug.
• permissions_check()Checks if the user has permissions to make the request.
• _sanitize_template_id()Requesting this endpoint for a template like 'twentytwentytwo//home' requires using a path like /wp/v2/templates/twentytwentytwo//home. There are special cases when WordPress routing corrects the name to contain only a single slash like 'twentytwentytwo/home'.
• get_items_permissions_check()Checks if a given request has access to read templates.
• get_items()Returns a list of templates.
• get_item_permissions_check()Checks if a given request has access to read a single template.
• get_item()Returns the given template
• update_item_permissions_check()Checks if a given request has access to write a single template.
• update_item()Updates a single template.
• create_item_permissions_check()Checks if a given request has access to create a template.
• create_item()Creates a single template.
• delete_item_permissions_check()Checks if a given request has access to delete a single template.
• delete_item()Deletes a single template.
• prepare_item_for_database()Prepares a single template for create or update.
• prepare_item_for_response()Prepare a single template output for response
• get_wp_templates_original_source_field()Returns the source from where the template originally comes from.
• get_wp_templates_author_text_field()Returns a human readable text for the author of the template.
• prepare_links()Prepares links for the request.
• get_available_actions()Get the link relations available for the post and current user.
• get_collection_params()Retrieves the query params for the posts collection.
• get_item_schema()Retrieves the block type' schema, conforming to JSON Schema.

Source code

View on Trac ↗View on GitHub ↗

17class WP_REST_Templates_Controller extends WP_REST_Controller {18 19	/**20	 * Post type.21	 *22	 * @since 5.8.023	 * @var string24	 */25	protected $post_type;26 27	/**28	 * Constructor.29	 *30	 * @since 5.8.031	 *32	 * @param string $post_type Post type.33	 */34	public function __construct( $post_type ) {35		$this->post_type = $post_type;36		$obj             = get_post_type_object( $post_type );37		$this->rest_base = ! empty( $obj->rest_base ) ? $obj->rest_base : $obj->name;38		$this->namespace = ! empty( $obj->rest_namespace ) ? $obj->rest_namespace : 'wp/v2';39	}40 41	/**42	 * Registers the controllers routes.43	 *44	 * @since 5.8.045	 * @since 6.1.0 Endpoint for fallback template content.46	 */47	public function register_routes() {48		// Lists all templates.49		register_rest_route(50			$this->namespace,51			'/' . $this->rest_base,52			array(53				array(54					'methods'             => WP_REST_Server::READABLE,55					'callback'            => array( $this, 'get_items' ),56					'permission_callback' => array( $this, 'get_items_permissions_check' ),57					'args'                => $this->get_collection_params(),58				),59				array(60					'methods'             => WP_REST_Server::CREATABLE,61					'callback'            => array( $this, 'create_item' ),62					'permission_callback' => array( $this, 'create_item_permissions_check' ),63					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),64				),65				'schema' => array( $this, 'get_public_item_schema' ),66			)67		);68 69		// Get fallback template content.70		register_rest_route(71			$this->namespace,72			'/' . $this->rest_base . '/lookup',73			array(74				array(75					'methods'             => WP_REST_Server::READABLE,76					'callback'            => array( $this, 'get_template_fallback' ),77					'permission_callback' => array( $this, 'get_item_permissions_check' ),78					'args'                => array(79						'slug'            => array(80							'description' => __( 'The slug of the template to get the fallback for' ),81							'type'        => 'string',82							'required'    => true,83						),84						'is_custom'       => array(85							'description' => __( 'Indicates if a template is custom or part of the template hierarchy' ),86							'type'        => 'boolean',87						),88						'template_prefix' => array(89							'description' => __( 'The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`' ),90							'type'        => 'string',91						),92					),93				),94			)95		);96

Changelog

Introduced in 5.8.0. Unchanged from 6.7.7 through 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 6.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-templates-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.