KANTENNA.COM

Solarized

HOME > WEBプログラム覚書 > [WordPress] テンプレートルーティングのメモ

[WordPress] テンプレートルーティングのメモ

WordPressが呼びだすテンプレートをTEMPLATEPATH直下じゃなくてTEMPLATEPATH/views/とかにできるのか調べた時のメモ。バージョンはWordPress 3.3 日本語版。

wp_includes/tempate_loader.php

テンプレートの選択、呼び出しはこのファイルで実行される。

template_redirectアクション

リクエストされたページの表示に使用するテンプレートファイルを判断する前に実行し、プラグインがテンプレートファイルの選択を上書きできるようにする。

プラグイン API/アクションフック一覧 - WordPress Codex 日本語版

とあるが、基本的にここで何をしようが、次のテンプレート選択処理に入る気がする。例外投げるとかdieするとかリダイレクトするとかすれば別だが。なのでtemplate_redirectはテンプレートファイルの選択を上書きというより、 wordpressがテンプレートを読み込む前に、リダイレクトしたいとか何らかの処理をしたい場合に利用するものっぽい。

本当にここでテンプレート選択処理をしたいのなら、/index.phpで設定されてる

PHP

<?php
define('WP_USE_THEMES', true);
?>

を削除するかfalseにすればテンプレート選択処理には入らないので、リダイレクト先のファイルでテンプレートのルーティングを実装すればよい。このファイルってコアに含まれるのだろうか？

で、WordPressがルーティングしたテンプレートを変更したい場合。

ルーティングしたいテンプレートが決まっている場合。

wp_includes/theme.phpのget_query_template()関数内で設定されている {$type}_templateフィルターを利用する。

$typeには、indexとか404とかcategoryとか呼ばれるテンプレートのタイプ名?が入る。

WordPressをサイトの一部として利用していて、404はサイトのものを利用したい場合。まぁ404.phpから呼び出すとかでもいいんだけど例ってことで。

PHP

<?php
add_filter('404_template', 'my_404_template', $templates);
function my_404_template($template) {
return $_SERVER['DOCUMENT_ROOT'] . '/errors/404.php';
}
?>

$templateにはWordPressのルーティングで決定されたテンプレートのパスが入る。この場合、

ABSPATH/wp-content/themes/theme_name/404.php

のように。

全てをルーティングしたい場合

template_loader.php内でテンプレートが呼ばれる直前に apply_filters( 'template_include', $template )というフィルタが設定されているのでこれにフックすればよい。

$templateはインクルードされるテンプレートのフルパス。 function.php内でこんな感じで設定する。

PHP

<?php
add_filter('template_include', 'my_template_include', $template);
function my_template_include($template) {
$name = pathinfo($template, PATHINFO_FILENAME);
switch ($name) {
case '404':
$load_file = $_SERVER['DOCUMENT_ROOT'] . '/errors/404.php';
brea;
default:
$load_file = $template;
break;
}
return $load_file;
}
?>

ただ、この場合テーマ直下をindex.phpとfunction.phpとstyle.cssだけにした場合 $templateにはindex.phpしか入ってこない。

WordPressのテンプレート階層はTEMPLATEPATHにあるファイルの存在を確認することで決定しているので TEMPLATEPATH/views/をテンプレート設置場所にしたい場合、TEMPLATEPATH自体を変更しないといけない。

ただfunction.phpが呼ばれる時点ではTEMPLATEPATHは決定されているので、ここがfunction.phpの限界点。 TEMPLATEPATHを変更するにはプラグインを利用する必要がある。

TEMPLATEPATHの変更

TEMPLATEPATHはwp-includes/theme.phpのget_template_directory()の実行結果で決まっていて、この関数では

PHP

<?php
return apply_filters( 'template_directory', $template_dir, $template, $theme_root );
?>

が設定されているので、プラグインで、

PHP

<?php
template_directory($template_dir, $template, $theme_root)
{
return $template_dir . '/views/';
}
?>

とすることで、TEMPLATEPATHの変更が可能となる。でもってテンプレートが呼び出される直前で実行されるtemplate_includeに

PHP

<?php
add_filter('template_include', 'my_template_include', $template);
function my_template_include($template)
{
// グローバルなオブジェクトとか変数に
// 本来呼び出されるファイルのパスを保存。
Configure::write('View.file', $template);
// WordPressは常にテーマ直下のindex.phpを呼び出す
return get_theme_root() . DS . get_template() . DS . 'index.php';
}
?>

としておくことでテーマ直下のindex.phpからテンプレートをビューとして呼び出せる。

PHP

<?php
<html>
<head>
</head>
<body>
<?php require_once(Configure::read('View.file')); ?>
</body>
</html>
?>

これでCakePHPのようにビューとレイアウトを分けることが出来そうな気がする。まだ実装はしてないのでわからんけどｗ

追記

ファイル確認はSTYLESHEETPATHが優先されるので、テーマ直下がSTYLESHEETPATHで、index.phpを呼び出すパターンの場合、上記だとviews/index.phpではなくテーマ直下のindex.phpが選択される。なので

PHP

<?php
// WordPressは常にテーマ直下のfront_controller.phpを呼び出す
return get_theme_root() . DS . get_template() . DS . 'front_controller.php';
?>

など、フロントコントローラーはWordPressのテンプレート階層で利用されないファイル名にした方がよい。

その他メモ

funtions.phpはTEMPLATEPATHとSTYLESHEETPATHが異なる場合、STYLESHEETPATHが最初に検索され存在しない場合、TEMPLATEPATHも検索するのでどちらにおいてもよい。
get_header()など使わなくなるので、そこらへんのアクションにフックされているプラグインとかは動かなくなる。使いたい場合、自分でトリガーすればよい。