Свой тип секции

Результат: тип появляется в каталоге Блоки. Схема JSON и пути chunk описаны в определении секции.

Что нужно заранее

Не правьте core/components/pagebuilder/sections/: upgrade пакета затрёт файл. Для UI-типа нужно право pagebuilder_manage_types.

Плагин

1. Положите JSON рядом с вашим компонентом.
2. Создайте chunk с именем из поля chunk.
3. В Элементы → Плагины создайте плагин, подпишите его на pbOnRegisterSectionDefinitions, прочитайте JSON и вызовите $registry->register(SectionDefinition::fromArray(...)).

<?php

use PageBuilder\Section\SectionDefinition;

switch ($modx->event->name) {
    case 'pbOnRegisterSectionDefinitions':
        /** @var \PageBuilder\Section\SectionRegistry $registry */
        $registry = $modx->event->params['registry'];
        $path = $modx->getOption('core_path') . 'components/mypackage/sections/custom.json';
        $payload = json_decode((string) file_get_contents($path), true);
        if (!is_array($payload)) {
            break;
        }
        $payload['source'] = 'code';
        $payload['readOnly'] = true;
        $registry->register(SectionDefinition::fromArray($payload));
        break;
}

Ключ с _ или category: dev в production-каталог не попадает. requires проверяет SectionRequirementChecker.

Что проверить

Ключ виден в каталоге на вкладке Секции.

UI-тип (Pro)

В панели управления создайте тип через mgr/sectiontype/*. Запись лежит в pb_section_types. Upgrade PageBuilder эти строки не перезаписывает.

Откат

Скройте тип в панели или уберите регистрацию из плагина.

Пример: тип «Кейс»

Нужно право pagebuilder_manage_types. CMP Blocks, новый тип, ключ case, подпись «Кейс», категория content.

name	type	label
title	text	Заголовок
client	text	Клиент
image	image	Фото
description	textarea	Что сделали
result	text	Результат

Чанк с именем из поля chunk:

<section class="pb-section pb-section--case">
  <div class="pb-section__inner">
    {if $title}<h2 class="pb-heading">{$title|escape}</h2>{/if}
    {if $client}<p class="pb-lead">{$client|escape}</p>{/if}
    {if $description}<p>{$description|escape}</p>{/if}
    {if $result}<p>{$result|escape}</p>{/if}
  </div>
</section>

Картинку выводите partial pagebuilder_partial_image, как у секции image.

См. также

• Разработчик
• Каталог секций