W3cubDocs

/WordPress

get_single_template()

Retrieve path of single template in current or parent template. Applies to single Posts, single Attachments, and single custom post types.

Description

The hierarchy for this template looks like:

  1. {Post Type Template}.php
  2. single-{post_type}-{post_name}.php
  3. single-{post_type}.php
  4. single.php

An example of this is:

  1. templates/full-width.php
  2. single-post-hello-world.php
  3. single-post.php
  4. single.php

The template hierarchy and template path are filterable via the ‘$type_template_hierarchy’ and ‘$type_template’ dynamic hooks, where $type is ‘single’.

See also

Return

(string) Full path to single template file.

Source

File: wp-includes/template.php 

function get_single_template() {
	$object = get_queried_object();

	$templates = array();

	if ( ! empty( $object->post_type ) ) {
		$template = get_page_template_slug( $object );
		if ( $template && 0 === validate_file( $template ) ) {
			$templates[] = $template;
		}

		$name_decoded = urldecode( $object->post_name );
		if ( $name_decoded !== $object->post_name ) {
			$templates[] = "single-{$object->post_type}-{$name_decoded}.php";
		}

		$templates[] = "single-{$object->post_type}-{$object->post_name}.php";
		$templates[] = "single-{$object->post_type}.php";
	}

	$templates[] = 'single.php';

	return get_query_template( 'single', $templates );
}

Uses

Uses Description
wp-includes/query.php: get_queried_object()

Retrieve the currently-queried object.
wp-includes/functions.php: validate_file()

Validates a file name and path against an allowed set of rules.
wp-includes/template.php: get_query_template()

Retrieve path to a template
wp-includes/post-template.php: get_page_template_slug()

Get the specific template filename for a given post.

Changelog

Version Description
4.7.0 {Post Type Template}.php was added to the top of the template hierarchy.
4.4.0 single-{post_type}-{post_name}.php was added to the top of the template hierarchy.
1.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_single_template