Перейти к содержимому

Регистрация атрибутов

Атрибуты задаются в массиве blockstudio.attributes файла block.json.

Простой пример

JSON
{
  "name": "my-theme/my-block",
  "title": "My Block",
  "blockstudio": {
    "attributes": [
      {
        "id": "title",
        "type": "text",
        "label": "Title"
      },
      {
        "id": "content",
        "type": "textarea",
        "label": "Content"
      }
    ]
  }
}

Свойства атрибутов

Все атрибуты имеют следующие свойства:

Свойство Тип Описание
id строка Уникальный идентификатор атрибута
type строка Тип поля (text, textarea, select и т. д.)
label строка Метка, отображаемая в редакторе
default смешанный Значение атрибута по умолчанию
help строка Текст подсказки, отображаемый рядом с меткой
position строка Где отображается поле: inspector (по умолчанию) или toolbar
conditions массив Условная логика отображения или скрытия поля

Положение

По умолчанию все поля отображаются в инспекторе блока (боковой панели). Изменить это можно с помощью свойства position:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "alignment",
        "type": "select",
        "label": "Alignment",
        "position": "toolbar",
        "options": [
          { "value": "left", "label": "Left" },
          { "value": "center", "label": "Center" },
          { "value": "right", "label": "Right" }
        ]
      }
    ]
  }
}

Значения по умолчанию

Задайте значения по умолчанию с помощью свойства default:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "title",
        "type": "text",
        "label": "Title",
        "default": "Hello World"
      },
      {
        "id": "showBorder",
        "type": "toggle",
        "label": "Show Border",
        "default": true
      }
    ]
  }
}

Текст подсказки

Добавьте текст подсказки для пользователей:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "apiKey",
        "type": "text",
        "label": "API Key",
        "help": "Enter your API key from the settings page"
      }
    ]
  }
}

Доступ к атрибутам

В шаблоне атрибуты доступны через сокращенную запись $a (или $attributes):

PHP
<h1><?php echo $a['title']; ?></h1>
<p><?php echo $a['content']; ?></p>

Или в Twig:

Twig
<h1>{{ a.title }}</h1>
<p>{{ a.content }}</p>

Кулинарная книга шаблонов полей