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

Переход с ACF Blocks

Если вы создавали пользовательские блоки WordPress с помощью ACF (Advanced Custom Fields), перейти на Blockstudio будет просто. Концепции похожи: вы определяете поля, пишете шаблон, и блок появляется в редакторе. Различия заключаются в том, что Blockstudio самостоятельно обнаруживает папки блоков, объявляет поля в собственной схеме в block.json и передаёт каждому шаблону значения полей одним массивом $a.

В этом руководстве пошагово описан переход, а также приведены параллельные сравнения подходов ACF и Blockstudio.

Главное отличие

Начиная с ACF 6.0, блок ACF представляет собой block.json с ключом acf, указывающим шаблон отображения, а каждая папка блока регистрируется отдельным вызовом register_block_type(). Поля берутся из группы полей, привязанной к блоку правилом расположения Block (созданной в панели администратора, синхронизированной через Local JSON или зарегистрированной с помощью acf_add_local_field_group()), либо, начиная с ACF PRO 6.8.1, из встроенного массива acf.fields в том же block.json. Blockstudio заменяет регистрацию автоматическим обнаружением файлов: создайте папку с block.json и index.php, и блок зарегистрируется автоматически.

ACF:

JSON
{
  "name": "acf/hero",
  "title": "Hero",
  "acf": {
    "renderTemplate": "template.php"
  }
}
PHP
add_action( 'init', function () {
  register_block_type( __DIR__ . '/blocks/hero' );
} );
PHP
acf_add_local_field_group([
  'key'      => 'group_hero',
  'title'    => 'Hero Fields',
  'fields'   => [
    ['key' => 'field_title', 'name' => 'title', 'type' => 'text', 'label' => 'Title'],
    ['key' => 'field_image', 'name' => 'image', 'type' => 'image', 'label' => 'Background', 'return_format' => 'array'],
  ],
  'location' => [[['param' => 'block', 'operator' => '==', 'value' => 'acf/hero']]],
]);
PHP
<?php
$title = get_field('title');
$image = get_field('image');
?>
<div class="hero" <?php if ($image) : ?>style="background-image: url(<?php echo esc_url($image['url']); ?>)"<?php endif; ?>>
  <h1><?php echo esc_html($title); ?></h1>
</div>

Blockstudio:

JSON
{
  "name": "my-theme/hero",
  "title": "Hero",
  "blockstudio": {
    "attributes": [
      { "id": "title", "type": "text", "label": "Title" },
      { "id": "image", "type": "files", "label": "Background", "multiple": false }
    ]
  }
}
PHP
<div useBlockProps class="hero" <?php if ($a['image']) : ?>style="background-image: url(<?php echo esc_url($a['image']['url']); ?>)"<?php endif; ?>>
  <h1><?php echo esc_html($a['title']); ?></h1>
</div>

Вызовы регистрации и функции отображения нет: регистрацией служит структура папок, а поля находятся в block.json рядом с шаблоном. Шаблон обращается к $a вместо вызова get_field().

Регистрация блока

ACF

Современные блоки ACF регистрируются из block.json с ключом acf (renderTemplate или renderCallback, а также такими параметрами, как blockVersion). Их загружают отдельным явным вызовом register_block_type() для каждой папки блока, обычно на init в functions.php или в файле плагина. В старых блоках может использоваться acf_register_block_type(). ACF считает его устаревшим начиная с ACF 6.0, но он по-прежнему работает, поэтому такие блоки можно переносить тем же способом.

Blockstudio

Создайте папку в каталоге blockstudio/ вашей темы (или в blocks/, если так удобнее). Добавьте block.json со стандартными метаданными блока WordPress и ключом blockstudio. Готово.

Код
theme/
└── blockstudio/
    └── hero/
        ├── block.json
        └── index.php

block.json использует стандартный формат WordPress block.json с ключом blockstudio для полей и конфигурации:

JSON
{
  "name": "my-theme/hero",
  "title": "Hero",
  "category": "theme",
  "icon": "cover-image",
  "description": "Full-width hero section with background image.",
  "blockstudio": {
    "attributes": []
  }
}

Доступ к значениям полей

Это самое распространённое изменение, которое потребуется внести при переходе.

ACF Blockstudio
get_field('title') $a['title']
get_field('title', $post_id) $a['title'] (доступно всегда)
the_field('title') <?php echo $a['title']; ?>
have_rows('items') / the_row() foreach ($a['items'] as $item)
get_sub_field('name') $item['name']

Переменная $a — это сокращённая запись для $attributes; она содержит значения всех полей текущего блока. Она всегда доступна в шаблоне и в редакторе, и на фронтенде.

Переменные шаблона

Blockstudio предоставляет несколько переменных в каждом шаблоне:

Переменная Сокращённая запись Описание
$attributes $a Все значения полей
$block $b Метаданные блока (имя, заголовок, dir, url, postId)
$context $c Контекст родительского блока
$content Содержимое InnerBlocks
$post_id ID текущей записи (работает в редакторе и на фронтенде; post_id или postId в Twig)

Сопоставление типов полей

Большинство типов полей ACF имеют прямой эквивалент в Blockstudio. Синтаксис JSON отличается, но понятия легко сопоставить.

Текстовые поля и поля содержимого

ACF:

PHP
['name' => 'title', 'type' => 'text', 'label' => 'Title', 'default_value' => 'Hello']
['name' => 'bio', 'type' => 'textarea', 'label' => 'Bio', 'rows' => 4]
['name' => 'content', 'type' => 'wysiwyg', 'label' => 'Content']

Blockstudio:

JSON
{ "id": "title", "type": "text", "label": "Title", "default": "Hello" }
{ "id": "bio", "type": "textarea", "label": "Bio", "rows": 4 }
{ "id": "content", "type": "wysiwyg", "label": "Content" }

Для редактируемого текста в редакторе блоков (а не просто текстового поля ввода) используйте тип richtext с компонентом <RichText />:

JSON
{ "id": "heading", "type": "richtext" }
PHP
<RichText attribute="heading" tag="h1" placeholder="Enter heading" />

Поля изображений и файлов

Поля image и file в ACF соответствуют типу files в Blockstudio:

ACF:

PHP
['name' => 'photo', 'type' => 'image', 'return_format' => 'array']
['name' => 'gallery', 'type' => 'gallery', 'return_format' => 'array']
['name' => 'document', 'type' => 'file', 'return_format' => 'array']

Blockstudio:

JSON
{ "id": "photo", "type": "files", "label": "Photo", "multiple": false }
{ "id": "gallery", "type": "files", "label": "Gallery", "multiple": true }
{ "id": "document", "type": "files", "label": "Document", "multiple": false, "allowedTypes": ["application/pdf"] }

Структура возвращаемого объекта аналогична:

PHP
// ACF
$image = get_field('photo');
echo $image['url'];
echo $image['alt'];

// Blockstudio
echo $a['photo']['url'];
echo $a['photo']['alt'];

Доступные свойства: ID, title, alt, caption, description, href, url, sizes. Размеры указаны в sizes, например $a['photo']['sizes']['full-width'].

Списки, переключатели и флажки

ACF:

PHP
[
  'name' => 'color',
  'type' => 'select',
  'choices' => ['red' => 'Red', 'blue' => 'Blue'],
  'return_format' => 'value',
]

Blockstudio:

JSON
{
  "id": "color",
  "type": "select",
  "label": "Color",
  "options": [
    { "value": "red", "label": "Red" },
    { "value": "blue", "label": "Blue" }
  ]
}

Используйте "returnFormat": "both", чтобы получить и значение, и подпись:

PHP
echo $a['color']['value'];  // "red"
echo $a['color']['label'];  // "Red"

Тот же подход применим к типам radio и checkbox.

Переключатель и логическое значение

ACF:

PHP
['name' => 'show_cta', 'type' => 'true_false', 'label' => 'Show CTA']

Blockstudio:

JSON
{ "id": "showCta", "type": "toggle", "label": "Show CTA" }

ACF:

PHP
['name' => 'cta', 'type' => 'link', 'return_format' => 'array']

// Template
$link = get_field('cta');
echo $link['url'];
echo $link['title'];
echo $link['target'];

Blockstudio:

JSON
{ "id": "cta", "type": "link", "label": "CTA", "opensInNewTab": true }
PHP
echo $a['cta']['url'];
echo $a['cta']['title'];
echo $a['cta']['target'];

Цвет и градиент

ACF:

PHP
['name' => 'bgColor', 'type' => 'color_picker', 'label' => 'Background']

Blockstudio:

JSON
{ "id": "bgColor", "type": "color", "label": "Background" }
{ "id": "bgGradient", "type": "gradient", "label": "Background Gradient" }

Тип color интегрируется с цветовой палитрой WordPress. Тип gradient предоставляет средство выбора градиента.

Числа, диапазоны и даты

ACF:

PHP
['name' => 'count', 'type' => 'number', 'min' => 1, 'max' => 10]
['name' => 'opacity', 'type' => 'range', 'min' => 0, 'max' => 100, 'step' => 5]
['name' => 'eventDate', 'type' => 'date_picker']

Blockstudio:

JSON
{ "id": "count", "type": "number", "label": "Count", "min": 1, "max": 10 }
{ "id": "opacity", "type": "range", "label": "Opacity", "min": 0, "max": 100, "step": 5 }
{ "id": "eventDate", "type": "date", "label": "Event Date" }

Повторители

Поле-повторитель ACF напрямую соответствует типу repeater в Blockstudio. В шаблонах ACF обычно используют цикл have_rows() / the_row() / get_sub_field() (в повторителе get_field() также возвращает массив строк); Blockstudio предоставляет только обычный массив PHP, уже в формате $a.

ACF:

PHP
['name' => 'features', 'type' => 'repeater', 'sub_fields' => [
  ['name' => 'title', 'type' => 'text'],
  ['name' => 'description', 'type' => 'textarea'],
]]

// Template
if (have_rows('features')) :
  while (have_rows('features')) : the_row();
    echo get_sub_field('title');
    echo get_sub_field('description');
  endwhile;
endif;

Blockstudio:

JSON
{
  "id": "features",
  "type": "repeater",
  "label": "Features",
  "min": 1,
  "max": 10,
  "attributes": [
    { "id": "title", "type": "text", "label": "Title" },
    { "id": "description", "type": "textarea", "label": "Description" }
  ]
}
PHP
<?php foreach ($a['features'] as $feature) : ?>
  <h3><?php echo esc_html($feature['title']); ?></h3>
  <p><?php echo esc_html($feature['description']); ?></p>
<?php endforeach; ?>

Повторители Blockstudio поддерживают вложенность до трёх уровней.

Группы

Поле группы ACF соответствует типу group в Blockstudio. К идентификаторам полей внутри групп добавляется префикс с идентификатором группы.

ACF:

PHP
['name' => 'author', 'type' => 'group', 'sub_fields' => [
  ['name' => 'name', 'type' => 'text'],
  ['name' => 'role', 'type' => 'text'],
]]

// Template
$author = get_field('author');
echo $author['name'];
echo $author['role'];

Blockstudio:

JSON
{
  "id": "author",
  "type": "group",
  "title": "Author",
  "attributes": [
    { "id": "name", "type": "text", "label": "Name" },
    { "id": "role", "type": "text", "label": "Role" }
  ]
}
PHP
<?php $author = bs_get_group($a, 'author'); ?>
<p><?php echo esc_html($author['name']); ?></p>
<p><?php echo esc_html($author['role']); ?></p>

Помощник bs_get_group() удаляет префикс группы из идентификаторов полей, упрощая доступ к ним. Без него к полям пришлось бы обращаться как к $a['author_name'] и $a['author_role'].

Условная логика

И ACF, и Blockstudio поддерживают условную логику для показа и скрытия полей в зависимости от значений других полей.

ACF:

PHP
['name' => 'showSubtitle', 'type' => 'true_false'],
[
  'name' => 'subtitle',
  'type' => 'text',
  'conditional_logic' => [[['field' => 'field_showSubtitle', 'operator' => '==', 'value' => '1']]]
]

Blockstudio:

JSON
{ "id": "showSubtitle", "type": "toggle", "label": "Show Subtitle" },
{
  "id": "subtitle",
  "type": "text",
  "label": "Subtitle",
  "conditions": [[{ "id": "showSubtitle", "operator": "==", "value": true }]]
}

Условия Blockstudio ссылаются напрямую на идентификаторы полей (не на ключи полей). Доступные операторы: ==, !=, includes, !includes, empty, !empty, <, >, <=, >=.

Blockstudio также поддерживает глобальные условия по типу записи, её ID, роли пользователя и ID пользователя:

JSON
{
  "conditions": [[{ "type": "postType", "operator": "==", "value": "page" }]]
}

InnerBlocks

И ACF, и Blockstudio поддерживают InnerBlocks, позволяя вкладывать другие блоки в пользовательский блок. Здесь используются тот же тег <InnerBlocks /> и те же атрибуты allowedBlocks, template и templateLock, поэтому эту часть шаблона обычно можно перенести без изменений.

Blockstudio:

PHP
<div useBlockProps class="my-wrapper">
  <InnerBlocks
    allowedBlocks='<?php echo esc_attr(wp_json_encode(["core/heading", "core/paragraph", "core/image"])); ?>'
    template='<?php echo esc_attr(wp_json_encode([
      ["core/heading", ["placeholder" => "Section title"]],
      ["core/paragraph", ["placeholder" => "Section content"]]
    ])); ?>'
    templateLock="insert"
  />
</div>

На фронтенде тег <InnerBlocks /> заменяется отображённым содержимым блока, а в редакторе — компонентом React.

Хранение метаданных записи

И ACF Blocks, и Blockstudio по умолчанию хранят значения полей в виде атрибутов блока в содержимом записи, а не в метаданных записи. Это значит, что значения полей нельзя запрашивать с помощью WP_Query, если не включить хранение в метаданных.

ACF добавил необязательное хранение блоков в метаданных записи в ACF PRO 6.3 через usePostMeta: true для одного блока верхнего уровня на страницу. В Blockstudio предусмотрено включение этой возможности для каждого поля с помощью свойства storage:

JSON
{
  "id": "featured",
  "type": "toggle",
  "label": "Featured",
  "storage": {
    "type": "postMeta",
    "postMetaKey": "is_featured"
  }
}

Ключ метаданных регистрируется автоматически с помощью show_in_rest. Обращайтесь к нему откуда угодно с помощью get_post_meta($post_id, 'is_featured', true).

Для значений всего сайта (например, страниц настроек ACF) используйте хранилище параметров:

JSON
{
  "storage": {
    "type": "option",
    "optionKey": "site_company_name"
  }
}

Расширение существующих блоков

Правило расположения блоков в ACF связывает группы полей только с блоками ACF и не добавляет поля в основные блоки или блоки сторонних разработчиков. Для основных блоков, таких как «Заголовок», «Абзац», «Изображение» и «Кнопка», в ACF используется механизм привязки блоков WordPress API, связывающий существующие атрибуты блоков со значениями полей ACF. С помощью Blockstudio можно добавлять новые поля и элементы управления в любой зарегистрированный блок через файлы расширений.

Создайте файл расширения в каталоге blockstudio:

JSON
{
  "name": "core/heading",
  "blockstudio": {
    "extend": true,
    "attributes": [
      {
        "id": "accentColor",
        "type": "color",
        "label": "Accent Color",
        "set": [{ "attribute": "style", "value": "color: {attributes.accentColor}" }]
      }
    ]
  }
}

Свойство set автоматически применяет значение поля к HTML блока. Используйте шаблоны подстановки, чтобы расширить сразу несколько блоков: "name": "core/*".

Список проверки миграции

  1. Создайте папку блока в theme/blockstudio/{block-name}/ с файлами block.json и index.php.
  2. Перенесите определения полей из группы полей блока (Local JSON, acf_add_local_field_group() или встроенного массива acf.fields) в массив blockstudio.attributes в block.json. Замените name на id, удалите key и при необходимости скорректируйте названия типов.
  3. Обновите доступ к шаблону: замените get_field('name') на $a['name']. Замените циклы have_rows() на foreach ($a['repeater'] as $item).
  4. Замените get_sub_field() на прямое обращение к массиву: $item['fieldId'].
  5. Добавьте useBlockProps к внешнему элементу шаблона для корректной интеграции с редактором.
  6. Перенесите условную логику из conditional_logic в conditions у ACF и Blockstudio соответственно, используя идентификаторы полей вместо их ключей.
  7. Добавьте хранилище для полей, которые раньше запрашивались через get_post_meta() или использовались в WP_Query.
  8. Удалите код регистрации ACF: вызовы register_block_type() и ключи acf перенесенных блоков (или их вызовы acf_register_block_type()), а также группы их полей, независимо от того, находятся ли они в Local JSON, acf_add_local_field_group(), встроенном массиве acf.fields или панели администратора.
  9. Проверьте блоки в редакторе, убедитесь, что поля отображаются правильно, а затем проверьте результат на сайте.