テンプレートでの出力(メディア・参照・地図・アップロード)


この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です

このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。

このページの型は、キー@path のような派生キーで値を出します。派生キーの多くは保存されず、表示のたびにメディアや参照先から作られます。書く場所(モジュール)は「テンプレートでの出力(基本の型)」と同じです。

メディア画像

キー と キー@media にメディアの ID を保存します。表示のときに、次の派生キーが付きます。

派生キー

内容

@path

画像のパス(001/202611/xxx.png?v=… のような相対パス)。%{MEDIA_ARCHIVES_DIR} を前に付けて使います

@alt・@caption・@link・@text

メディアの代替テキスト・キャプション・リンク・説明

@width・@height・@ratio・@imageSize

画像の幅・高さ・縦横比・大きさ

@name・@extension・@fileSize・@type

ファイル名・拡張子・バイト数・種類

@focalX・@focalY

焦点の位置

@thumbnail

サムネイル(/media/… のようにルートから始まる URL です。%{MEDIA_ARCHIVES_DIR} は付けません)

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_main_image:veil -->
<figure>
  <img src="%{MEDIA_ARCHIVES_DIR}{cf_main_image@path}" alt="{cf_main_image@alt}" width="{cf_main_image@width}" height="{cf_main_image@height}">
  <!-- BEGIN cf_main_image@caption:veil --><figcaption>{cf_main_image@caption}</figcaption><!-- END cf_main_image@caption:veil -->
</figure>
<!-- END cf_main_image:veil -->
<!-- END_MODULE Entry_Field -->
{% set f = module('V2_Entry_Field').fields %}
{% set image = f.cf_main_image.value %}
{% if image and image.path %}
<figure>
  <img src="{{ image.path }}" alt="{{ image.alt }}" width="{{ image.width }}" height="{{ image.height }}">
  {% if image.caption %}<figcaption>{{ image.caption }}</figcaption>{% endif %}
</figure>
{% endif %}

メディアファイル

保存の形はメディア画像と同じです。@path はファイルのダウンロード用の URL で、/media-download/… のようにルートから始まります。前には何も付けません(%{MEDIA_ARCHIVES_DIR} を付けると URL が壊れます)。メディア画像の @path とは前に付けるものが違う点に注意してください。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_pdf:veil -->
<p><a href="{cf_pdf@path}">{cf_pdf@name}</a>({cf_pdf@extension})</p>
<!-- END cf_pdf:veil -->
<!-- END_MODULE Entry_Field -->
{% set pdf = module('V2_Entry_Field').fields.cf_pdf.value %}
{% if pdf and pdf.path %}<p><a href="{{ pdf.path }}">{{ pdf.name }}</a>({{ pdf.extension }})</p>{% endif %}

メディアギャラリー

キー と キー@media に、メディアの ID を複数保存します。標準のテンプレートでは、ループの名前に派生キーまで書きます(キー:loop ではメディアの ID だけが出ます)。ループの中で {cf_gallery@path} のようにループに書いた派生キーは出ますが、それ以外の派生キー({cf_gallery@alt} など)は空になります。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_gallery:veil -->
<ul class="gallery">
  <!-- BEGIN cf_gallery@path:loop -->
  <li><img src="%{MEDIA_ARCHIVES_DIR}{cf_gallery@path}" alt=""></li>
  <!-- END cf_gallery@path:loop -->
</ul>
<!-- END cf_gallery:veil -->
<!-- END_MODULE Entry_Field -->

代替テキストを出したいときは、次のどちらかにします。

  • 添字を付けて、1 枚ずつ書く。{cf_gallery@alt[1]} のように [ ] に 0 から数えた番号を書くと、その番号の画像の代替テキストが出ます([0] が 1 枚目、[1] が 2 枚目)。枚数が決まっているときに向いています。

  • Twig で書く(下の例)。ループの中で image.path・image.alt などをすべて使えます。枚数が決まっていないときはこちらを使います。

<!-- 1 枚目と 2 枚目を、代替テキスト付きで出す(添字は 0 始まり) -->
<img src="%{MEDIA_ARCHIVES_DIR}{cf_gallery@path[0]}" alt="{cf_gallery@alt[0]}">
<img src="%{MEDIA_ARCHIVES_DIR}{cf_gallery@path[1]}" alt="{cf_gallery@alt[1]}">
{% set f = module('V2_Entry_Field').fields %}
{% if f.cf_gallery.array %}
<ul class="gallery">
  {% for image in f.cf_gallery.array %}
  <li><img src="{{ image.path }}" alt="{{ image.alt }}"></li>
  {% endfor %}
</ul>
{% endif %}

メディア画像(1 枚)をフィールドグループに入れて作る方法もあります(フィールドグループ(繰り返し))。

参照(1 件)

キー と キー@entry(カテゴリーは @category、ユーザーは @user)に参照先の ID を保存します。公開側では、参照先の値を次の派生キーで出せます。値は表示のたびに参照先から読むため、参照先を更新すると表示も変わります。

参照先

派生キー

エントリー

@title(タイトル)・@url(リンク先。エントリーのリンク先の設定に従います)・@permalink(エントリー自身の URL)・@code・@datetime・@categoryName・@eid・@bid・@cid・@uid

カテゴリー

@name・@code・@url・@cid・@bid

ユーザー

@name・@code・@icon(アイコン画像の URL)・@uid

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_related@title:veil -->
<p>関連: <a href="{cf_related@url}">{cf_related@title}</a>({cf_related@datetime}[date('Y/m/d')])</p>
<!-- END cf_related@title:veil -->

<!-- BEGIN cf_area@name:veil -->
<p>エリア: <a href="{cf_area@url}">{cf_area@name}</a></p>
<!-- END cf_area@name:veil -->

<!-- BEGIN cf_writer@name:veil -->
<p class="writer"><img src="{cf_writer@icon}" alt="">{cf_writer@name}</p>
<!-- END cf_writer@name:veil -->
<!-- END_MODULE Entry_Field -->
{% set f = module('V2_Entry_Field').fields %}
{% set related = f.cf_related.value %}
{% if related and related.title %}
<p>関連: <a href="{{ related.url }}">{{ related.title }}</a></p>
{% endif %}
  • 閲覧している人から見えない参照先(下書き・非公開・公開期間外など)と、削除された参照先は出しません。

  • Twig では、参照先のエントリー・カテゴリーのカスタムフィールドも f.キー.value.fields.参照先のキー.value で読めます(1 段だけ)。ユーザーのカスタムフィールドは、定義の設定「ユーザーのカスタムフィールドを公開側に出す」をオンにしたときだけ読めます。

参照(複数)

標準のテンプレートでは、ループの名前に派生キーまで書きます。ループの中で値が出るのは、ループに書いた派生キーだけです(cf_related_list@title:loop の中の {cf_related_list@url} は空になります)。タイトルとリンクを並べて出すときは、Twig を使うか、「参照(1 件)」をフィールドグループに入れて作ってください。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_related_list@title:veil -->
<ul>
  <!-- BEGIN cf_related_list@title:loop -->
  <li>{cf_related_list@title}</li>
  <!-- END cf_related_list@title:loop -->
</ul>
<!-- END cf_related_list@title:veil -->
<!-- END_MODULE Entry_Field -->

上の例はタイトルだけを出します。リンクも付けるときは、次の Twig か、下のフィールドグループの例を使います。

{% set f = module('V2_Entry_Field').fields %}
{% if f.cf_related_list.array %}
<ul>
  {% for entry in f.cf_related_list.array %}
  <li><a href="{{ entry.url }}">{{ entry.title }}</a></li>
  {% endfor %}
</ul>
{% endif %}

参照(1 件)をフィールドグループ related_group(メンバー related_item)に入れた場合は、標準のテンプレートでも次のように書けます(フィールドグループの出力は、ステージングなどの環境でも確かめてください)。

<ul>
<!-- BEGIN related_group:loop -->
  <li><a href="{related_item@url}">{related_item@title}</a></li>
<!-- END related_group:loop -->
</ul>

地図

キー に「緯度,経度」を、キー@lat・キー@lng・キー@zoom に緯度・経度・ズームを保存します。

<!-- BEGIN_MODULE Entry_Field -->
<!-- BEGIN cf_map@lat:veil -->
<p><a href="https://www.google.com/maps?q={cf_map@lat},{cf_map@lng}" target="_blank" rel="noopener">地図を開く</a></p>
<div class="map" data-lat="{cf_map@lat}" data-lng="{cf_map@lng}" data-zoom="{cf_map@zoom}"></div>
<!-- END cf_map@lat:veil -->
<!-- END_MODULE Entry_Field -->
{% set map = module('V2_Entry_Field').fields.cf_map.value %}
{% if map and map.lat %}
<div class="map" data-lat="{{ map.lat }}" data-lng="{{ map.lng }}" data-zoom="{{ map.zoom }}"></div>
{% endif %}

地図を描くスクリプトは、テーマで用意します。

アーカイブ画像・アーカイブファイル(ユーザー)

ユーザーの定義でだけ使える型です。従来の画像・ファイルのカスタムフィールドと同じ派生キーで保存します。

型

派生キー

アーカイブ画像

@path・@x・@y・@alt・@fileSize、大きい画像・小さい画像・正方形の画像は @largePath・@tinyPath・@squarePath など(X・Y・Alt・FileSize も同じ形)

アーカイブファイル

@path・@baseName・@fileSize・@originalName・@downloadName

<!-- BEGIN_MODULE User_Field -->
<!-- BEGIN cf_photo@path:veil -->
<img src="%{ARCHIVES_DIR}{cf_photo@path}" width="{cf_photo@x}" height="{cf_photo@y}" alt="{cf_photo@alt}">
<!-- END cf_photo@path:veil -->
<!-- BEGIN cf_profile_pdf@path:veil -->
<a href="%{ARCHIVES_DIR}{cf_profile_pdf@path}">{cf_profile_pdf@originalName}</a>
<!-- END cf_profile_pdf@path:veil -->
<!-- END_MODULE User_Field -->
{% set uf = module('V2_User_Field').fields %}
{% if uf.cf_photo.value and uf.cf_photo.value.path %}
<img src="{{ uf.cf_photo.value.path }}" alt="{{ uf.cf_photo.value.alt }}">
{% endif %}