リファレンスタグ

• On this Page

  • リファレンスタグの解析

リファレンスタグを利用して、サイト内の様々なエレメントへの参照を作成できます。テーブルフィールド内のテキストセルを含む、あらゆるテキストフィールドで使用できます。

リファレンスタグの構文は、次のようになります。

{<Type>:<Identifier>:<Property>}

ご覧の通り、それらは3つのセグメントで構成されています。

1. <Type> – 参照を作成するエレメントのタイプ。これは完全修飾のエレメントクラス名（例：craft\elements\Entry）、または、エレメントタイプの「リファレンスハンドル」です。

   コアのエレメントタイプは、次のリファレンスハンドルを持っています。

   • entry
   • asset
   • tag
   • user
   • globalset

2. <Identifier> – エレメントの ID、または、エレメントタイプによってサポートされているカスタム識別子。

   エントリは次のカスタム識別子をサポートしています。

   • entry-slug
   • sectionHandle/entry-slug

   @<Site> 構文を利用して、エレメントが読み込まれるべきサイト ID、UUID、または、ハンドルを識別子に含めることもできます。

3. <Property> （オプション） – リファレンスタグが返すべきエレメントのプロパティ。省略した場合、エレメントの URL が返されます。

   利用可能なプロパティのリストは、エレメントタイプのクラスリファレンスを参照してください。

   • craft\elements\Entry
   • craft\elements\Asset
   • craft\elements\Tag
   • craft\elements\User
   • craft\elements\GlobalSet

   カスタムフィールドのハンドルもサポートされています。フィールドタイプは文字列として表すことができる値を持っています。

実例

有効なリファレンスタグは、次の通りです。

• {asset:123:filename} – ID が 123 のアセットのファイル名を（craft\elements\Asset::getFilename() 経由で）返します。
• {entry:about-us:intro} – スラグが about-us のエントリのカスタムフィールド intro の値を返します。
• {entry:about-us@en:intro} – スラグが about-usで、ハンドルが en のサイトから読み込まれた、エントリのカスタムフィールド intro の値を返します。
• {entry:blog/whats-on-tap} – スラグが whats-on-tap の blog セクションのエントリの URL を返します。
• {craft\commerce\Variant:123:price} – ID が 123 の Commerce Variant オブジェクトの price を返します。
• {globalset:aGlobalSet:uid} – ハンドルが aGlobalSet のグローバル設定の UID を返します。

リファレンスタグの解析

parseRefs フィルタを利用して、テンプレート内のリファレンスタグの文字列を解析できます。

{{ entry.body|parseRefs|raw }}