表示されているページでどのテンプレートファイルが使われているかを調べる

※Web開発

2024.05.03

表示されているページでどのテンプレートファイルが使われているかを調べる | KoMariCote
WordPressで表示されているページに使われているテンプレートファイルが何かを知りたい時にファイル名を確認方法メモです。
komaricote.com

表示されているページ上で使われているテンプレートファイルを表示させる方法メモです。

WordPressでのサイト制作中にどのファイルを修正すればいいのか分からない場合、思い当たるファイルを片っぱしから調べるのは結構な手間です。その手間を省きたいときに、参考にしてみてください。

PHPコードで確認

WordPress には $template というグローバル変数があり、これを利用することでそのページで使用されているテンプレートファイルを確認することができます。

【ファイル名を表示させるためのコード参考】

if(is_user_logged_in()) { // ログイン中の場合
  global $template;
  $current_template = basename($template);
  echo '使用されているテンプレートファイル：'.$current_template;
}

$template にはファイルまでのパスが入っています。（ /wp_content/themes/theme_name/***.php という文字列）このままだと認識しづらいので、***.php の部分だけ表示させるために basename() を使用します。

PHP: basename – Manual

ヘッダーやそのページ上のどこかに表示させる場合には、サイトにアクセスしてきたユーザーには表示されないように「ログインしている時」という条件分岐もつけます。

一度だけ簡易的に表示させたい場合は上記の形でもいいと思いますが、常時わかるようにしておきたい場合はツールバーにメニューを追加して表示させるのがおすすめです。ここならログイン中であればツールバーに表示されますし、サイトページには表示させずに確認することができます。

function add_adminbar_menu() {
  global $wp_admin_bar;
  global $template;
  $current_template = basename($template);
  $wp_admin_bar->add_node( array(
    'id'    => 'template_file_name',
    'title' => '使用されているテンプレートファイル : '. $current_template,
  ));
}
add_action('admin_bar_menu', 'add_adminbar_menu', 500);

上記コードをfunctions.phpに追加すると、以下のようにツールバーに表示されるようになります。