テンプレートの探し方


Ver. 3.2.15 から Twig テンプレートの {% include %} タグおよび {{ include() }} 関数でもインクルードファイルのパスがHTMLコメントとして出力されるようになりました。

テーマをカスタマイズしているとテンプレートファイルはどうしても多くなってきます。そんな大量のテンプレートの中から、目的のテンプレートを探すのは時間がかかります。また自分以外が作ったテーマを触る場合もテンプレートを探すのに一苦労します。

そこで、ここでは目的のテンプレートを早く見つける方法を紹介していきます。

下準備

管理ページ > コンフィグ > 出力設定の HTMLコメントの削除 のチェックがついていたら外します。


この準備は Ver. 3.2.22 より、HTMLコメント除去機能がデバッグモードが無効のときのみ動作するように変更されたため不要になりました。デバッグモードの有効化から作業してください。


出力設定管理画面

出力設定管理画面


デバッグモード を 有効化します。

Ver. 3.1 から管理者ユーザーごとに、ユーザー編集画面で、デバッグモードとベンチマークモードになることができるオプションが用意されているのでこちらを利用します。


デバッグモードとベンチマークモードになることができるオプションが用意されています。

デバッグモードとベンチマークモードになることができるオプションが用意されています。

また、Ver. 3.1未満の場合や、ログインしていない状態の表示を確認したい場合は、閲覧ユーザーからのアクセス時にDEBUG_MODEをOFFにする事はオススメできないので、config.server.php で以下のように特定IPアドレスからのアクセスのみDEBUG_MODEをOFFにする事もできます。

if ( $_SERVER['REMOTE_ADDR'] === 'xxx.xxx.xxx.xxx' ) {
  define('DEBUG_MODE', 1);
} else {
  define('DEBUG_MODE', 0);
}

テンプレート確認

ログインをして、テンプレートを確認したいページに移動します。ログインをしている状態だと以下のように、現在表示中のテンプレートと表示され、どのテンプレートが使用されているかわかります。


管理ボックス

管理ボックス


ただし、このテンプレートに目的の修正箇所があればいいのですが、インクルードされたテンプレートがほとんどだと思います。そこで次は修正箇所周辺のソースを確認します。確認すると以下のようにインクルードされている箇所がHTMLコメントで表示されるようになります。


インクルードファイルのソース周辺

インクルードファイルのソース周辺


インクルードファイルのパスがHTMLコメントでわかるようになりました。これで目的のテンプレートをすぐに探すことが出来るようになりました。