56

I've found this to display the current name of the file used in template:

function get_template_name () {
    foreach ( debug_backtrace() as $called_file ) {
        foreach ( $called_file as $index ) {
            if ( !is_array($index[0]) AND strstr($index[0],'/themes/') AND !strstr($index[0],'footer.php') ) {
                $template_file = $index[0] ;
            }
        }
    }
    $template_contents = file_get_contents($template_file) ;
    preg_match_all("Template Name:(.*)\n)siU",$template_contents,$template_name);
    $template_name = trim($template_name[1][0]);
    if ( !$template_name ) { $template_name = '(default)' ; }
    $template_file = array_pop(explode('/themes/', basename($template_file)));
    return $template_file . ' > '. $template_name ;
}

Source: get name of page template on a page

It works quite well, except that in the backend, in the template select box, I get this ugly extra entry:

screenshot

Does anybody have any idea how to fix it? I don't even know why this function is called in the backend. Is there a conditional function like is_frontend() - maybe this would solve the problem?

  • 2
    @chodorowicz - While I will stop one step short of calling the selection of functions.php as a bug, I will agree completely with your premise. To make matters worse I scanned the WordPress core code and found about 5 places where there could have been a hook to allow you to handle this issue yet I found none. I'd suggest posting a ticket on core.trac.wordpress.org. – MikeSchinkel Feb 26 '11 at 20:13
  • @MikeSchinkel - thanks for comment, but doesn't template_include hook, which t31os suggested, solve the issue? Or maybe I've misunderstood you. – chodorowicz Feb 27 '11 at 15:29
  • 1
    @MikeSchinkel - it already has a patch :) core.trac.wordpress.org/ticket/16689 – chodorowicz Feb 28 '11 at 17:33
  • 1
    I've made a new plugin in order to display the current template. Check it on wordpress.org/extend/plugins/display-template-name – user16658 Jun 1 '12 at 11:32
  • 4
    ^ ie. you took the code from my answer and wrapped it into a plugin. And you did all that without providing any credit to the origin, neither myself or the WP stackexchange... nice... :/ – t31os Mar 30 '14 at 21:08
65

You could set a global variable during the template_include filter and then later check that global vairable to see which template has been included.

You naturally wouldn't want the complete path along with the file, so i'd recommend truncating down to the filename using PHP's basename function.

Example code:
Two functions, one to set the global, one to call upon it.

add_filter( 'template_include', 'var_template_include', 1000 );
function var_template_include( $t ){
    $GLOBALS['current_theme_template'] = basename($t);
    return $t;
}

function get_current_template( $echo = false ) {
    if( !isset( $GLOBALS['current_theme_template'] ) )
        return false;
    if( $echo )
        echo $GLOBALS['current_theme_template'];
    else
        return $GLOBALS['current_theme_template'];
}

You can then call upon get_current_template wherever you need it in the theme files, noting this naturally needs to occur after the template_include action has fired(you won't need to worry about this if the call is made inside a template file).

For page templates there is is_page_template(), bearing in mind that will only help in the case of page templates(a far less catch all function).

Information on functions used or referenced above:

  • Awesome! I knew there had to be a simpler way. – racl101 Mar 8 '13 at 22:11
  • One to add to the top of my debugging functions list. – Jules Jul 16 '13 at 21:41
19

apparently this is enough:

add_action('wp_head', 'show_template');
function show_template() {
    global $template;
    echo basename($template);
}

or just use it directly in template (I tend to echo in footer.php in HTML comment)

<?php global $template; echo basename($template); ?>
  • 1
    That won't work with get-template-part just so you know, it only shows single.php (for example) and not the file it is in. – torinagrippa Sep 25 '12 at 15:11
  • Yes, it's true. To get the name of included file you'd probably need to use something like this echo __FILE__; – chodorowicz Oct 5 '12 at 12:25
  • this is fine, for example in cases when you modify the default template without assigning it to a post in backoffice. For example using custom routes and the template_include filter. Thank you. – Luca Reghellin Sep 15 '16 at 10:05
  • How could I do this within a loop? I'm trying to output the URL to one page of each template file. – JacobTheDev Feb 28 '17 at 15:07
  • @JacobTheDev maybe using echo __FILE__ - because this won't work, it displays only main, initial template – chodorowicz Mar 7 '17 at 22:08
17

Between native WP functions like get_template_part() and PHP's native includes the most reliable way to see theme's files used is to fetch list of all included files and filter out whatever doesn't belong to theme (or themes when parent and child combination is used):

$included_files = get_included_files();
$stylesheet_dir = str_replace( '\\', '/', get_stylesheet_directory() );
$template_dir   = str_replace( '\\', '/', get_template_directory() );

foreach ( $included_files as $key => $path ) {

    $path   = str_replace( '\\', '/', $path );

    if ( false === strpos( $path, $stylesheet_dir ) && false === strpos( $path, $template_dir ) )
        unset( $included_files[$key] );
}

var_dump( $included_files );
9

An addition (more sweet code) to other answers here.

Template Name

To just get the current page template name, use the following line.

is_page() AND print get_page_template_slug( get_queried_object_id() );

File Name

When you just want to echo the current template file name, go with the following

Edit: Here's the new version of the plugin wrapped up in a class. It shows both the current template file name, as well as the template hierarchy file name in the shutdown hook at the most bottom of the page.

What the plugin tells you:

  • Is the template from the parent of child/current theme?
  • Is the template served from a subfolder? If yes: Tells you the name
  • The template file name.

Just copy the following code into a file and name it wpse10537_template_info.php, upload it to your plugins directory and activate it.

<?php
/** Plugin Name: (#10537) »kaiser« Get Template file name */

if ( ! class_exists( 'wpse10537_template_name' ) )
{
    add_action( 'plugins_loaded', array( 'wpse10537_template_name', 'init' ) );

class wpse10537_template_name
{
    protected static $instance;

    public $stack;

    public static function init()
    {
        is_null( self :: $instance ) AND self :: $instance = new self;
        return self :: $instance;
    }

    public function __construct()
    {
        if ( is_admin() )
            return;

        add_action( 'wp', array( $this, 'is_parent_template' ), 0 );
        add_action( 'wp', array( $this, 'get_template_file' ) );
        add_action( 'template_include', array( $this, 'get_template_name' ) );
        add_action( 'shutdown', array( $this, 'get_template_name' ) );
    }

    public function get_template_name( $file )
    {
        if ( 'template_include' === current_filter() )
        {
            $this->to_stack(
                 "Template file"
                ,basename( $file )
            );
            return $file;
        }

        // Return static var on echo call outside of filter
        if (
            current_user_can( 'manage_options' )
            AND defined( 'WP_DEBUG' )
            AND WP_DEBUG 
        )
            return print implode( " &ndash; ", $this->stack );
    }

    public function get_template_file()
    {
        if ( ! is_post_type_hierarchical( get_post_type() ) )
            return;

        $slug = get_page_template_slug( get_queried_object_id() );
        if ( ! strstr( $slug, "/" ) )
            return $this->to_stack( "Template", $slug );

        $this->to_stack(
             "Subdirectory"
            ,strstr( $slug, "/", true )
        );

        $this->to_stack(
             "Template (in subdirectory)"
            ,str_replace( "/", "", strstr( $slug, "/" ) )
        );
    }

    public function is_parent_template()
    {
        if ( ! is_null( wp_get_theme()->parent ) )
            return $this->to_stack( 'from parent theme' );

        $this->to_stack( 'from current/child theme' );
    }

    public function to_stack( $part, $item = '' )
    {
        $this->stack[] = "{$part}: {$item}";
    }
} // END Class wpse10537_template_name

} // endif;

This plugin can run as MU-Plugin too.

You can then simply call wpse10537_get_template_name() at any point (in for example a theme template). This avoids cluttering the global namespace.

  • 1
    template_redirect is not passing anything, I think you are confusing with template_include. Also I'd check if inside the filter instead of if static var filled. If some code decides to run hook additional time it can wreck things. – Rarst Sep 15 '12 at 17:42
  • @Rarst Done/Fixed. Thanks for the hint and pointing out the filter name. – kaiser Sep 15 '12 at 19:18
5

The template name is stored in the postmeta table, so all you need to do is put this somewhere in your loop:

$template = get_post_meta( $post->ID, '_wp_page_template', true );
echo "Template: " . $template;
  • 2
    Yes, I know about this, but the problem is that it works only when a page has a set template. The cool thing about the code I posted is that it will tell you if current page is using front-page.php, index.php, single.php, page.php or any other file. Your code displays template name only for pages with custom page template. – chodorowicz Feb 26 '11 at 18:05
  • ah, sorry - my misunderstanding of your question. – Simon Blackbourn Feb 26 '11 at 18:23
  • @SimonBlackbourn It's help for my requirement. Thanks. – KarSho Oct 8 '13 at 7:04
3

This doesn't address all of the OP's question, but the code below is certainly more elegant than regular expressions and parsing the template file itself.

If you're on a Page that is using a Page Template, and you want to get the page template's Name (ie: the human-readable name that you defined in the comments at the top of your template PHP file), you can use this little nugget:

if ( is_page() && $current_template = get_page_template_slug( get_queried_object_id() ) ){
    $templates = wp_get_theme()->get_page_templates();
    $template_name = $templates[$current_template];
}

I wanted to get the template name because I was really sick of the silly-long-ass class names that the built-in WordPress body_class function creates when you're using a template. Luckily there's a filter hook at the very end of that function to let you append your own class names as well. Here's my filter. Hope someone finds it useful:

add_filter( 'body_class', 'gs_body_classes', 10, 2 );
function gs_body_classes( $classes, $class ){
    if ( is_page() && $current_template = get_page_template_slug( get_queried_object_id() ) ){
        $templates = wp_get_theme()->get_page_templates();
        $template_name = str_replace( " ", "-", strtolower( $templates[$current_template] ) );

        $classes[] = $template_name;
    }

    return $classes;
}

This filter will take whatever you named your page template, replace spaces with dashes and make everything lower case so it looks like all the other WordPress classes.

0

There's an issue with the preg_match_all line. Try this instead:

preg_match_all("/Template Name:(.*)\n/siU",$template_contents,$template_name);

Also, you can use if (!is_admin()) { .... } to run things on the frontend only.

  • Thanks for suggestion, they don't solve the problem, but they kinda directed me into solutions. It turns out that WP, while generating templates list, is looking even into functions.php finds the "/Template Name:(.*)\n/siU" and thus treats the functions.php as template file. I think this is WP bug, it shouldn't even look at this file. The solution: move the file into subdirectory. – chodorowicz Feb 26 '11 at 17:33
  • @chodorowicz: That's not a bug in WP, it's a bug in your function. – wyrfel Feb 26 '11 at 18:18
  • So basically WP forbids you to put string "Template Name:" (even in comment) in functions.php file. For me, personally, that's a bug, (small, but anyway) but that's the up to discussion, I suppose. I think you cannot say that the function itself is buggy. – chodorowicz Feb 26 '11 at 19:14
  • WP doesn't forbid you to do anything. But WP also doesn't promise you that you can loop over a debug_backtrace() to find out what template file you're using. Just because you found it on a WP support forum doesn't mean it's officially supported code. As you may see, your function explicitly expludes footer.php. You may as well add another condition that excludes functions.php. BTW: your function doesn't look for Template Name within each of the files, your loop has ended long before that. – wyrfel Feb 27 '11 at 6:00
  • The problem wasn't with debug_backtrace() - I can remove all the code and just leave preg_match_all("/Template Name..., or even just // Template Name: and WP treats then functions.php as template file, but thanks for comments - this is such a unique problem that, as you say, it's not fair to say it's a bug. t31os solution is clean and solves the whole issue. Greets. – chodorowicz Feb 27 '11 at 11:56
0

Play along with:

echo '<ul><li>'.implode('</li><li>', str_replace(str_replace('\\', '/', ABSPATH).'wp-content/', '', array_slice(str_replace('\\', '/', get_included_files()), (array_search(str_replace('\\', '/', ABSPATH).'wp-includes/template-loader.php', str_replace('\\', '/', get_included_files())) + 1)))).'</li></ul>';

Written at:

How do you find out which template page is serving the current page?

if admin-bar stuff path is showing at the top, or any other file, change the filename template-loader.php in this line of code to: whatever filname you need to break from.

if you need this in the admin bar, use the right priotity (earliest) to make shure no files are entered at the end of this list. For example:

add_action('admin_bar_menu', 'my_adminbar_template_monitor', -5);

priority -5 make shure it loads first. The key is to render this line at the right moment.

It does not returning the "current" template-file, but all the current in use for the current page-load. Maybe "cut out" with some logic from that idea.

The get_included_files() "last" key is the last registered included file, propably the last template-file/ -part used in the footer by sidebar widget or something. Propably, cos mutiple included files does not re-register/ populates again in get_included_files().

Otherwise, the intension must be clear to hack this problem. There is no way for a included file to report itself as included, until it has been included. Then its propably to late to use the scenario.

Most of the "time" you would like:

$template = get_current_loaded_template();
if($template == 'single-product.php') add_filter('the_title' ....
if($template == 'format-gallery.php') add_action('post_thumbnail' ....

But thats not possible if the template is loaded outside Wordpress core method of get_template_part. Re-design your needs instead! Maybe loop_start(), in_the_loop() and add_action('the_post') has the solution you want, to alter data depending of template thats gonna load for each entry within a loop.

-3
global $post;
$templateName = get_page_template_slug( $post->ID );
//echo $templateName;
var_dump( $templateName );

protected by Pieter Goosen Feb 17 '16 at 9:05

Thank you for your interest in this question. Because it has attracted low-quality or spam answers that had to be removed, posting an answer now requires 10 reputation on this site (the association bonus does not count).

Would you like to answer one of these unanswered questions instead?

Not the answer you're looking for? Browse other questions tagged or ask your own question.