コンテンツへスキップ

ブロックフィールド

blockフィールド型を使うと、別のBlockstudioブロックを属性として参照できます。参照先ブロックのフィールドは、カスタムフィールドと同じidStructure、overridesの仕組みでインラインに展開されます。テンプレートでは、レンダリング済みのブロック出力が値として返されます。

定義

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "card",
        "type": "block",
        "block": "mytheme/card",
        "idStructure": "card_{id}"
      }
    ]
  }
}

参照先ブロックのフィールドがインラインに展開されます。mytheme/cardにheadingフィールドとcontentフィールドがある場合、ホストブロックにはcard_heading属性とcard_content属性が追加されます。

テンプレートでの使用

テンプレートでは、フィールドの値として参照先ブロックのレンダリング済みHTMLが返されます:

Twig
<div class="hero">
  <h1>{{ a.title }}</h1>
  {{ a.card }}
</div>
PHP
<div class="hero">
  <h1><?php echo $a['title']; ?></h1>
  <?php echo $a['card']; ?>
</div>

戻り値の形式

returnFormatを使って、フィールド値の戻り値を指定します:

値 説明
rendered (デフォルト)参照先ブロックのレンダリング済みHTML出力
data 参照先ブロックの属性値を含む連想配列
both rendered(HTML)とdata(属性値)を含むオブジェクト
JSON
{
  "id": "card",
  "type": "block",
  "block": "mytheme/card",
  "idStructure": "card_{id}",
  "returnFormat": "data"
}

オーバーライド

カスタムフィールドと同じように、参照先ブロックの個々のフィールドプロパティを上書きできます:

JSON
{
  "id": "card",
  "type": "block",
  "block": "mytheme/card",
  "idStructure": "card_{id}",
  "overrides": {
    "heading": { "default": "Welcome", "label": "Card Title" },
    "content": { "label": "Card Body" }
  }
}

対応対象

ブロックフィールドは通常のブロックとコンポーネントブロックの両方で使えます。コンポーネントブロックはプログラムからのレンダリングを前提に設計されているため、特に適しています。