Skip to content
  1. Extras
  2. PageBuilder
  3. Getting started
  4. System settings

System settings

MODX namespace: pagebuilder. Database key: pagebuilder_<name>.

The extra manifest has 24 keys. On install or upgrade Phinx/resolver adds missing ones. Existing values are not overwritten (update.settings = false).

Keys added in 1.0.3+:

KeySection
pagebuilder_inspector_visibility_enabledEditor
pagebuilder_default_breakpointResponsive
pagebuilder_responsive_breakpointsResponsive
pagebuilder_responsive_applyResponsive

Keys added in 1.0.9–1.0.10:

KeySection
pagebuilder_catalog_examples_enabledCatalog
pagebuilder_resource_view_modeEditor
pagebuilder_responsive_editor_enabledResponsive

Paths and preview

KeyTypeDefaultDescription
pagebuilder_core_pathtext{core_path}components/pagebuilder/Path to component PHP core
pagebuilder_assets_urltext{assets_url}components/pagebuilder/URL for connector, preview, static assets
pagebuilder_preview_secrettextfrom resolver / site_uuidSecret for signing draft preview tokens
pagebuilder_load_frontend_cssboolean1Load pagebuilder-sections.css when the PageBuilder snippet runs
pagebuilder_preview_include_template_cssboolean1Pull <link rel="stylesheet"> from the resource template into preview iframe
pagebuilder_preview_css_urlstextareaemptyExtra CSS for preview (comma-separated), placeholders {assets_url} and others

Empty pagebuilder_preview_secret falls back to site_uuid. On production set a separate secret if manager preview should not rely on a predictable UUID.

CSS order in preview iframe (preview.php):

  1. Stylesheet from the resource template if pagebuilder_preview_include_template_css = 1
  2. URLs from pagebuilder_preview_css_urls (comma or newline separated)
  3. pagebuilder-sections.css and pagebuilder-preview.css

If the theme loads CSS only via Fenom or @import without <link>, add files explicitly to preview_css_urls. Placeholders: {assets_url}, {base_url}, {site_url}.

Resource form tabs

KeyTypeDefaultDescription
pagebuilder_resource_tab_enabledboolean0Sections tab on the resource form
pagebuilder_resource_tab_parentstextemptyParent IDs comma-separated. Empty with tab enabled = all resources
pagebuilder_resource_tab_indexnumber-1Sections tab position: 0 first, 1 second, -1 last
pagebuilder_resource_tables_tab_enabledboolean0Tables tab (resource table data)
pagebuilder_resource_tables_tab_indexnumber-1Tables tab position

Collections (control panel)

KeyTypeDefaultDescription
pagebuilder_collections_enabledboolean0Dynamic tab set from Collections in the control panel
pagebuilder_collections_modx_bridge_enabledboolean0Tab type modx_collections

Enable only if you use Collections and configured tab sets in the PageBuilder control panel. Details: Control panel → Collections.

Resource table data

Tables tab on the resource (pagebuilder_resource_tables_tab_enabled) or table tab type in Collections.

ProcessorPurpose
mgr/datatable/listResource tables
mgr/datatable/rows/listRows: search, page, limit, filters
mgr/datatable/rows/save / removeRow CRUD

JSON filters by column: { "price": { "op": "gte", "value": "10" } }. Operators: eq, contains, in, gte, lte, between, empty, not_empty.

On the site: PageBuilderTableRows snippet, data_table section. Details: Developer.

Editor

KeyTypeDefaultDescription
pagebuilder_fake_enabledboolean0Fake button in section inspector: fills fields with deterministic demo data (mgr/section/fake)
pagebuilder_inspector_visibility_enabledboolean0Visibility button in inspector: conditions, contexts, UTM, context copy dialog. Off by default: editor sees content fields only
pagebuilder_resource_view_modetexteditorialSection list on Sections tab: editorial or table. Manager can override with toolbar toggle (value in localStorage)

Catalog

KeyTypeDefaultDescription
pagebuilder_catalog_examples_enabledboolean1Examples tab in section catalog (Pro JSON presets). Turn off to hide without deleting package files. Toggle also in CMP Section types with capability presets (mgr/config/save)

Responsive breakpoints

Screen thresholds for fields with responsive: true and preview iframe width in the manager.

KeyTypeDefaultDescription
pagebuilder_responsive_editor_enabledboolean0Button and tabs for different field values on desktop / tablet / mobile in the inspector. Off by default. Saved breakpoint maps on the site work until the editor saves the field as a single value
pagebuilder_default_breakpointtextdesktopKey from breakpoints JSON when responsive_apply=manual, if no ?pb_bp=
pagebuilder_responsive_breakpointstextareadesktop / tablet / mobile JSONArray { key, minWidth, previewWidth, label }. Section type can override with responsiveBreakpoints
pagebuilder_responsive_applytextmanualmanual: one value on the site (SEO-safe). css: all values in HTML + media queries. In chunks for such fields use {$title|pb_text} instead of |escape

Default JSON example:

json
[
  { "key": "desktop", "minWidth": 1024, "previewWidth": 1280, "label": "Desktop" },
  { "key": "tablet", "minWidth": 768, "previewWidth": 768, "label": "Tablet" },
  { "key": "mobile", "minWidth": 0, "previewWidth": 390, "label": "Mobile" }
]

Field data details: Fields overview → responsive.

Public API

Read-only JSON for headless frontends. Details: Public API.

KeyTypeDefaultDescription
pagebuilder_public_api_enabledboolean0Enable assets/components/pagebuilder/api.php
pagebuilder_public_api_keytextemptyAPI key. Empty: requests without key (dev only)
pagebuilder_public_api_cors_originstextarea*Allowed CORS origins for browser requests

Snippet relation

SettingSnippet parameterBehavior
pagebuilder_load_frontend_cssload_cssParameter overrides system setting
wrap_pageWrap in <div class="pb-page"> (default same as load_css)

Parameters load_css and wrap_page are set only on snippet call; they are not listed in snippet properties.