小粋空間  -  a cheap joke and a play on words site

MTSetVarBlock と MTSetVarTemplate の違いについて

Movable Type 4 では、MTSetVar タグや MTSetVarBlock タグを用いた制御が数多く行われています。 本エントリーでは、新たに追加された MTSetVarTemplate タグについて解説します。

１．MTSetVarTemplate タグの機能

MTSetVarTemplate タグで囲まれた内容を、変数として値を設定します。

<MTSetVarTemplate name="foo">
  <!-- do something -->
</MTSetVarTemplate>

なお、MTSetVarTemplate タグは、ドキュメントによれば MT 管理画面での使用が目的らしいので、ユーザのテンプレートで用いる可能性は低いかもしれません。

２．MTSetVarBlock タグとの違い

MTSetVarBlock タグは、ブロック内の内容が処理された結果を値として取得しますが、MTSetVarTemplate タグは、ブロックの内容が MTGetVar、あるいは MTVar タグで呼び出された時点ではじめて評価されます。

３．サンプル

ここでは MTIncludeタグ・MTGetVar タグと組み合わせた、MTSetVarBlock タグと MTSetVarTemplate タグの振舞いの違いを示したいと思います。

３．１ MTSetVarBlock + MTInclude + MTGetVar（OK）

MTSetVarTemplate タグは用いず、アーカイブテンプレートの MTInclude タグが実行された時点で MTEntries 全体が評価されるサンプルです。

アーカイブテンプレート

<$MTInclude module="test"$>
<$MTGetVar name="entries"$>

テンプレートモジュール（test）

<MTSetVarBlock name="entries">
<MTEntries>
<$MTEntryTitle$>
</MTEntries>
</MTSetVarBlock>

３．２ MTSetVarBlock + MTInclude + MTGetVar（NG）

アーカイブテンプレートの MTInclude で MTEntryTitle が評価されますが、評価時点では MTEntryTitle が MTEntries コンテキスト外のため、再構築エラーとなるサンプルです。

アーカイブテンプレート

<$MTInclude module="test"$>
<MTEntries>
<$MTGetVar name="entries"$>
</MTEntries>

テンプレートモジュール（test）

<MTSetVarBlock name="entries">
<$MTEntryTitle$>
</MTSetVarBlock>

３．３ MTSetVarTemplate + MTInclude + MTGetVar（OK）

３．２項の MTSetVarBlock タグを MTSetVarTemplate タグに置き換えることで、アーカイブのMTInclude 時点でMTEntryTitleは評価されず、MTGetVar（=MTEntires ブロック内）で評価されるので、期待通りの動作になります。

アーカイブテンプレート

<$MTInclude module="test"$>
<MTEntries>
<$MTGetVar name="entries"$>
</MTEntries>

テンプレートモジュール（test）

<MTSetVarTemplate name="entries">
<$MTEntryTitle$>
</MTSetVarTemplate>

４．参考：MT4 のデフォルトテンプレート

３項でサンプルをいくつか比較しましたが、実際には、デフォルトテンプレートの MTEntries 関連のタグデザインは下記の通りです。
MTGetVar は用いず、アーカイブテンプレートの MTEntries ブロックに直接 MTInclude が記述され、MTEntryTitleが評価されます。

アーカイブテンプレート

<MTEntries>
<$MTInclude module="test"$>
</MTEntries>

テンプレートモジュール（test）

<$MTEntryTitle$>

５．まとめ

MTSetVarTemplate を用いるケースとして、下記が考えられます。

• テンプレートモジュールをひとつにまとめたい
• ブロックタグとファンクションタグのテンプレートを分離したい
• ファンクションタグのテンプレートモジュールに、複数のバリエーションをもたせる（MTGetVar で振り分ける）

管理画面テンプレートは調査していないので、実際にはもう少し適正な使用方法があるかもしれません。