WP_REST_Posts_Controller::check_template( string $template, WP_REST_Request $request ): true|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$templatestring

Page template filename.

$requestWP_REST_Request

Request.

Return value

true|WP_Error

True if template is still valid or if the same as existing value, or a WP_Error if template not supported.

Performance profile

How much work a call to WP_REST_Posts_Controller::check_template() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

4–48

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 53.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_post()called directly

Further down the call graph this can also reach hook, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Posts_Controller::check_template() can have, taken from its control-flow graph on PHP 8.5.

Uses · 6

• get_post()Retrieves post data given a post ID or post object.
• get_page_template_slug()Gets the specific template filename for a given post.
• wp_get_theme()Gets a WP_Theme object for a theme.
• __()Retrieves the translation of $text.
• wp_get_theme()::get_page_templates()
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

1641	public function check_template( $template, $request ) {1642 1643		if ( ! $template ) {1644			return true;1645		}1646 1647		if ( $request['id'] ) {1648			$post             = get_post( $request['id'] );1649			$current_template = get_page_template_slug( $request['id'] );1650		} else {1651			$post             = null;1652			$current_template = '';1653		}1654 1655		// Always allow for updating a post to the same template, even if that template is no longer supported.1656		if ( $template === $current_template ) {1657			return true;1658		}1659 1660		// If this is a create request, get_post() will return null and wp theme will fallback to the passed post type.1661		$allowed_templates = wp_get_theme()->get_page_templates( $post, $this->post_type );1662 1663		if ( isset( $allowed_templates[ $template ] ) ) {1664			return true;1665		}1666 1667		return new WP_Error(1668			'rest_invalid_param',1669			/* translators: 1: Parameter, 2: List of valid values. */1670			sprintf( __( '%1$s is not one of %2$s.' ), 'template', implode( ', ', array_keys( $allowed_templates ) ) )1671		);1672	}

Changelog

Introduced in 4.9.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 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-posts-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.