適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす

説明

/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。

テンプレートファイルの優先順位

テンプレートファイルの種類はバージョンによって異なり、次に示す優先度で適用される。

具体的な例で説明すると、スラッグが'news'（カテゴリーidが21）というカテゴリーアーカイブページ（リクエストURLがhttp://localhost/category/news）がリクエストされたとしよう。その場合、テーマ内の category-news.php → category-21.php → category.php → archive.php → index.php の順にファイルが存在するか調べられ、最初に見つかったテンプレートファイルがリクエストに応答する（対象の投稿内容を表示する）ことになる。

フロントページ（トップページ）の優先順位

フロントページは、 is_front_page関数で行い、その後で is_home関数によって判断しており、管理者ページの「設定」「表示設定」「フロントページの表示」の指定によって振る舞いが変わる。この振る舞いのパターンは次の3種類である。

設定が「最新の投稿」になっている場合、テンプレートファイルの参照順は front-page.php → home.php → index.php の順になる。
設定が「固定ページ」で「フロントページ」が選択されて場合、 front-page.php → page.php → index.php の順になる。
設定が「固定ページ」で「投稿ページ」が選択されて場合、 home.php → index.php の順になる。

添付ファイルはMIMEタイプで振り分けできる

投稿タイプが添付ファイルのページは、attachment.php → index.phpの順に対応するが、添付ファイルのMIMEタイプに応じて個別のテンプレートファイルで対応することができる。MIMEタイプは「image/jpeg」の形式でファイルの種類を示すもので、このMIMEタイプであればテンプレートファイルは、image.php → jpeg.php → image_jpeg.php で対応することになる。実際、標準テーマ「TwentyEleven」では image.php が用意されているので、作り方はそちらを参考にするといい。

このMIMEタイプによるテンプレートファイルだが、今の参照順だとMIMEサブタイプの対応が多少注意が必要かもしれない。例えば標準テーマ「TwentyEleven」でJPEGファイル「image/jpeg」とPNGファイル「image/png」で異なる表示にする場合、すでに image.php が存在するため、jpeg.php や png.php を用意してもそれらの前に image.php が見つかってしまうため、そのままでは jpeg.php や png.php は有効にならない。簡単な対策としては、image.php を無くすことだが、その場合は他のイメージファイルの対応をどうするかという問題が生じる。
MIMEタイプのテンプレートファイルの参照順については、image_jpeg.php → jpeg.php → image.php のようにサブタイプ名を含んだテンプレートファイルから参照する方がより柔軟に対応できると思う。

固定ページは専用テンプレートファイルを指定できる

固定ページは、page.php → index.php の順に参照されるが、ほとんどは page.php で対応し、特定の固定ページについても page.php 内で表示内容を切り替えている方が多いのではないだろうか。
今回この記事をまとめる中での最大の発見は、投稿名（スラッグ）または投稿IDを指定することで、その固定ページ専用のテンプレートファイルを指定できるところ。例えば、固定ページに「about」という投稿名を付けた場合は、page-about.php を用意すればいい。これで page.php の中から表示内容を切り分け処理はなくなり、コードもすっきりする。

追記： get_page_template_slug関数で取得できる専用テンプレートファイルが指定されている場合はそれが最優先され、その後に投稿名（スラッグ）または投稿IDを含んだテンプレートファイルが順次適用されることになる。

追記：4.3.0では投稿（single）と固定ページ（page）の共通テンプレートsingular.phpが利用できるようになった。これにより、投稿（single）と固定ページ（page）が同じデザインの場合はsingle.phpとpage.phpを用意せず、singular.phpのみを用意すればよい。

4.4以降なら投稿ページでも専用テンプレートファイルを指定できる

従来の投稿ページは、single-{投稿タイプのスラッグ}.php → single.php → index.php の順に参照される。上記のように、固定ページば専用テンプレートファイルを指定できるが、投稿ページは標準では対応できなかった。
4.4からは投稿ページであっても専用テンプレートファイルを利用できるように変更された。具体的には、single-{投稿タイプのスラッグ}.php の前に single-{投稿タイプのスラッグ}-{投稿名}.php が優先されるようになり、特定の投稿ページで専用テンプレートファイルを利用できる。

追記：4.7.0では固定ページと同じように get_page_template_slug関数で取得できる専用テンプレートファイルが指定されている場合はそれが最優先される。

カスタムタクソノミーは taxonomy.php で

カテゴリーや投稿タグ以外のタクソノミーとしてカスタムタクソノミー（任意のタクソノミー）を登録できるようになっているが、taxonomy.php はそれらカスタムタクソノミーのアーカイブページ用の代表的なテンプレートファイルである。カスタムタクソノミーのテンプレートファイルは、taxonomy-{taxonomy}-{slug}.php → taxonomy-{taxonomy}.php → taxonomy.php → archive.php → index.php の順にファイルが存在するか調べられる。注意する点は、カテゴリーや投稿タグのようにタクソノミーIDを指定したテンプレートファイルがないところだろう（WordPress 3.2.1）。
ちなみにカスタムタクソノミーかどうかの判断は、 is_tax関数で調べることができ、archive.php で表示内容を切り分ける場合はこのis_taxを利用するとよいだろう。

このようにテンプレートファイルを整理してみると、その種類の多さを再認識させられた。表示内容が共通するところは上位レベルのテンプレートファイルで対応し、特定の条件のみで表示を切り替えなければならない時は下位レベルのテンプレートで対応することで、より効率よく、メンテナンス性の高いテーマを作成できる。テーマを作成する際は、どのリクエストの場合に下位レベルのテンプレートファイルを使用するかをきちんと考慮して設計したいものだ。