get_embed_template()

Retrieves an embed template path in the current or parent template.

Description

The hierarchy for this template looks like:

  1. embed-{post_type}-{post_format}.php
  2. embed-{post_type}.php
  3. embed.php

An example of this is:

  1. embed-post-audio.php
  2. embed-post.php
  3. embed.php

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

See also

Return

(string) Full path to embed template file.

Source

File: wp-includes/template.php

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

	$templates = array();

	if ( ! empty( $object->post_type ) ) {
		$post_format = get_post_format( $object );
		if ( $post_format ) {
			$templates[] = "embed-{$object->post_type}-{$post_format}.php";
		}
		$templates[] = "embed-{$object->post_type}.php";
	}

	$templates[] = 'embed.php';

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

Changelog

Version Description
4.5.0 Introduced.

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