ビルトインモジュール

基本的に「モジュール」と言う場合、多くは ビルトインモジュール を指します。
ビルトインモジュールは、主にエントリー系の情報を表示するために利用され、カテゴリー、ナビゲーション、バナー、トピックパスなど、サイト制作に欠かせない要素を構成するのに役立ちます。

ビルドインモジュールには従来からある標準モジュールと、Ver. 3.2 から追加された、V2モジュールがあります。V2モジュールは、twigテンプレートでのみ使用できる新しいモジュールになります。

標準モジュール

従来からある標準ビルトインモジュールは、次のようにHTMLコメントタグで囲んで記述します。

<!-- BEGIN_MODULE Entry_List -->
<div>
<!--#include file="/admin/module/setting.html"-->
<ul>
  <!-- BEGIN entry:loop -->
  <li><a href="{url}">{title}</a></li>
  <!-- END entry:loop -->
</ul>
</div>
<!-- END_MODULE Entry_List -->

<!-- BEGIN_MODULE モジュール名 —> から <!-- END_MODULE モジュール名 —> を1つのモジュールとして動作します。モジュールの中にモジュールを書く事もでき、モジュールの実行順としては、内側のモジュールが実行され、その後に外側のモジュールが動作するようになっています。

V2モジュール

Ver 3.2 で追加された、twigテンプレートで利用できるモジュールがV2モジュールになります。V2モジュールは、twigテンプレートでのみ呼び出すことができるモジュールです。

{% set entrySummary = module('V2_Entry_Summary') %}

<div>
  {{ include('/admin/module/setting.twig', { moduleInfo: entrySummary.moduleInfo }) }}
  <ul>
    {% for entry in entrySummary.items %}
    <li>
      <p><a href="{{ entry.url }}">{{ entry.title }}</a></p>
    </li>
    {% endfor %}
  </ul>
</div>

module(‘モジュール名’) 関数を使用して、モジュールの変数を読み込んで、twigテンプレートで呼び出した変数を利用して、組み立てます。

各種ビルトインモジュールの機能や変数表・スニペットについてはリファレンス内のビルトインモジュールのページをご覧ください。