docs.modx.pro
  1. Extras
  2. PageBuilder
  3. Recipes
  4. Custom section type

Custom section type ​

Result: the type shows up in the Blocks catalog. JSON shape and chunk paths are in section definition.

Plugin ​

  1. Keep the JSON next to your component. Do not edit core/components/pagebuilder/sections/. A package upgrade overwrites that folder.
  2. Create a chunk whose name matches the chunk field.
  3. Subscribe a plugin to pbOnRegisterSectionDefinitions and call registerFromFile.
php
<?php
switch ($modx->event->name) {
    case 'pbOnRegisterSectionDefinitions':
        /** @var \PageBuilder\Section\SectionRegistry $registry */
        $registry = $modx->event->params['registry'];
        $registry->registerFromFile($modx->getOption('core_path') . 'components/mypackage/sections/custom.json');
        break;
}

A key that contains _, or category: dev, stays out of the production catalog. SectionRequirementChecker evaluates requires.

UI type (Pro) ​

Create the type in the control panel through mgr/sectiontype/*. The row lives in pb_section_types. A PageBuilder upgrade does not overwrite those rows.

Check: the key is visible in the catalog on the Sections tab. Rollback: hide the type in the panel, or remove registerFromFile.

See also ​