get_page_template_slug( int|WP_Post|null $post = null ): string|false

Compatibility

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

Parameters

$postint|WP_Post|nulloptional

Post ID or WP_Post object. Default is global $post.Default: null

Return value

string|false

Page template filename. Returns an empty string when the default page template is in use. Returns false if the post does not exist.

Performance profile

How much work a call to get_page_template_slug() 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

7–18

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

10

10 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly

Further down the call graph this can also reach hook, cache, serialize, option 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 · 2 distinct outcomes

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

Uses · 2

• get_post()Retrieves post data given a post ID or post object.
• get_post_meta()Retrieves a post meta field for the given post ID.

Used by · 10

• WP_REST_Posts_Controller::check_template()Checks whether the template is valid for the given post.
• WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
• _WP_Editors::editor_settings()
• get_body_class()Retrieves an array of the class names for the body element.
• get_page_template()Retrieves path of page template in current or parent template.
• get_single_template()Retrieves path of single template in current or parent template. Applies to single Posts, single Attachments, and single custom post types.
• is_page_template()Determines whether the current post uses a page template.
• twentytwenty_body_classes()Adds conditional body classes.
• wp_get_post_content_block_attributes()Retrieves Post Content block attributes from the current post template.
• wp_xmlrpc_server::_prepare_page()Prepares page data for return in an XML-RPC object.

Source code

View on Trac ↗View on GitHub ↗

1904function get_page_template_slug( $post = null ) {1905	$post = get_post( $post );1906 1907	if ( ! $post ) {1908		return false;1909	}1910 1911	$template = get_post_meta( $post->ID, '_wp_page_template', true );1912 1913	if ( ! $template || 'default' === $template ) {1914		return '';1915	}1916 1917	return $template;1918}

Changelog

Introduced in 3.4.0. One change between 6.7.7 and 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/post-template.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.