WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Posts_Controller::handle_template()

WP_REST_Posts_Controller::handle_template( string $template, int $post_id, bool $validate = false )

In this article

Back to top

Sets the template for a post.

Parameters

$templatestringrequired
Page template filename.
$post_idintrequired
Post ID.
$validatebooloptional
Whether to validate that the template selected is valid.

Default:false

Source

public function handle_template( $template, $post_id, $validate = false ) {

	if ( $validate && ! array_key_exists( $template, wp_get_theme()->get_page_templates( get_post( $post_id ) ) ) ) {
		$template = '';
	}

	update_post_meta( $post_id, '_wp_page_template', $template );
}

View all references View on Trac View on GitHub

UsesDescription
wp_get_theme()wp-includes/theme.php

Gets a WP_Theme object for a theme.

WP_Theme::get_page_templates()wp-includes/class-wp-theme.php

Returns the theme’s post templates for a given post type.

update_post_meta()wp-includes/post.php

Updates a post meta field based on the given post ID.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 1 moreShow less
Used byDescription
WP_REST_Posts_Controller::create_item()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Creates a single post.

WP_REST_Posts_Controller::update_item()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Updates a single post.

Changelog

VersionDescription
4.9.0Added the $validate parameter.
4.7.0Introduced.

User Contributed Notes

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