コンテンツへスキップ

上書き

Blockstudioでは、ブロックを非常に細かく上書きできます。これは、ブロックを一から作り直さずに動作を変更したい場合に、共有ブロックライブラリで便利です。

block.json

まず、上書きするブロックの名前をnameキーに設定し、overrideキーをtrueに設定します。

JSON
{
  "name": "blockstudio/my-block",
  "title": "My overridden block title",
  "blockstudio": {
    "override": true
  }
}

overrideプロパティをtrueに設定すると、新しいblock.jsonのデータが元のブロックのデータとマージされます。つまり、元のブロックのプロパティをどれでも上書きできます。

属性

属性はidで上書きすることも、追加することもできます。たとえば、ブロックのwidth属性を上書きし、新しいheight属性を追加するとします。

JSON
{
  "name": "blockstudio/my-block",
  "title": "My overridden block title",
  "blockstudio": {
    "override": true,
    "attributes": [
      {
        "id": "width",
        "type": "number",
        "default": 280,
        "label": "Override width"
      },
      {
        "id": "height",
        "type": "number",
        "default": 280,
        "label": "New height"
      }
    ]
  }
}

同じidを持つ属性が見つかると、そのデータは元の属性とマージされます。見つからない属性はブロックに追加されます。

警告

属性を上書きする場合、値が変わらない場合でも、元の属性のtypeを指定する必要があります。

複雑な構造

リピーター、グループ、タブなど、複雑な構造を持つ属性を上書きする場合は、上書きする項目までの属性構造全体を指定する必要があります。

JSON
{
  "name": "blockstudio/my-block",
  "blockstudio": {
    "override": true,
    "attributes": [
      {
        "id": "tabs",
        "type": "tabs",
        "tabs": [
          {
            "id": "tab1",
            "attributes": [
              {
                "key": "group1",
                "type": "group",
                "title": "Group",
                "attributes": [
                  {
                    "id": "text",
                    "type": "text",
                    "label": "Override text"
                  }
                ]
              }
            ]
          },
          {
            "id": "tab2",
            "title": "Override tab",
            "attributes": [
              {
                "id": "group",
                "type": "group",
                "title": "Group ID",
                "attributes": [
                  {
                    "id": "text",
                    "type": "text",
                    "label": "Override text"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

アセット

ファイル名が一致するアセットファイルは置き換えられます。たとえば、元のブロックにstyle.cssファイルがある場合、上書きブロックのstyle.cssファイルに置き換えられます。元のブロックと名前が一致しないファイルはブロックに追加されます。

レンダリングテンプレート

新しいテンプレートファイルとしてindex.php、index.twig、index.blade.phpのいずれかを指定すると、レンダリングテンプレートを上書きできます。

Twigブロック

Twigテンプレートは、Twigのblock機能を使って、より細かく上書きできます。

架空の画像ブロックで、次のレンダリングテンプレートを使うとします。

Twig
<h1>Images:</h1>
{% for image in a.images %}
  <div class="content">
    {% block image %}
      <img src="{{ image.url }}" class="image" />
    {% endblock %}
  </div>
{% endfor %}

テンプレート全体を置き換える代わりに、Twigのextends機能を使えば、他の部分を維持したままテンプレートの特定の部分を上書きできます。

Twig
{% extends 'index.twig' %}

{% block image %}
  <figure>
    <img src="{{ image.url }}" class="image" />
    <figcaption>{{ image.caption }}</figcaption>
  </figure>
{% endblock %}