Bricksforge
These abilities register when Bricksforge is detected on the site and a Pro licence is active. If either is missing the module stays absent rather than failing at call time.
At a glance
Bricksforge registers 21 abilities: 9 that only read, 9 that write, and 3 marked destructive. That split is the practical answer to how much of this module can run unattended. Reads cost nothing and are safe to repeat, so discovery is the part to be generous with; the writes are where review belongs, and the destructive calls stop for an explicit confirmation every single time regardless of which profile is active.
What this module is for
Work with Bricksforge custom elements and tools, email templates and themes, and popup records through WPPilot Pro.
Before you rely on it: Test emails and popup behavior in their real delivery and display contexts before production activation.
Typical workflows
- Inventory enabled tools before changing the builder surface
- Duplicate an email template before revising it
- Review a popup record before activation or deletion
The Bricksforge integration page covers the same module from the workflow side, with the capability map and the questions worth asking before a first write.
Availability on your site
The Bricksforge module needs three things at once: WPPilot Free as the MCP foundation, an active Pro licence, and the companion plugin detected on the site. Miss any one and the module does not register, which is deliberate: an ability that appears in the tool list but fails at call time is worse than an ability that was never offered. What the connected agent can actually call is then narrowed twice more: by the safety profile active on the site, and by the WordPress capabilities of the user behind the credential. A read that succeeds for an administrator can be absent entirely for an editor.
Every write these abilities perform is recorded in the change ledger, and destructive calls can be routed through the approval queue so a person signs off before anything is applied. A successful tool result means the operation returned, not that the front end, the cache, and every dependent template are correct: that still needs a look.
Reads
Available in every safety profile, including Read Only. Inspection costs nothing and is not rate limited.
| Ability | What it does |
|---|---|
wppilot/bricksforge-check-setupCheck Bricksforge Setup | Reports the Bricksforge environment: plugin active/version/minimum status, Bricks theme version, activated tools and custom elements (numeric IDs resolved to names), and issues. Run this before using other Bricksforge abilities. Bricksforge custom elements register as regular Bricks elements — compose them into pages with the wppilot/bricks-* abilities. |
wppilot/bricksforge-get-email-templateGet Bricksforge Email Template | Reads one Bricksforge Email Designer template by id. Returns the metadata (name, status, subject, overridden emails, theme binding) always, and the full visual body (canvas) only when include_canvas=true — the canvas is the design tree, large and meant for a visual editor, so it is omitted by default. |
wppilot/bricksforge-get-email-themeGet Bricksforge Email Theme | Reads one saved Email Designer theme by id, returning its full stored settings (colors, typography, spacing — the exact keys depend on the Bricksforge version). Read-only. |
wppilot/bricksforge-get-popupGet Bricksforge Popup | Reads one Bricksforge popup config by id, returning every stored key (template, trigger + trigger params, displayOn/page, executions, animation, colors, close behaviour). Warnings flag configs that will never fire. |
wppilot/bricksforge-list-custom-elementsList Bricksforge Custom Elements | Lists the Bricksforge custom-element activation catalog: numeric ID, slug, name, active state, and the Bricks element name(s) each ID registers. Element IDs are a SEPARATE numbering space from tool IDs. ID 5 activates the whole Pro Forms bundle (form container, steps, and every field element) in one flag; ID 13 (API Query Builder Load More) auto-activates whenever the API Query Builder tool is active. Once an ID is active its elements are ordinary Bricks elements: fetch control schemas with wppilot/bricks-list-elements and compose them with the bricks content abilities. |
wppilot/bricksforge-list-email-templatesList Bricksforge Email Templates | Lists the Bricksforge Email Designer templates in compact form: id, name, status (active/inactive), subject, the WordPress/Bricks/WooCommerce emails each one overrides (condition types), and whether it uses a theme. The visual email body (canvas) is omitted — use bricksforge-get-email-template for one template. Authoring the visual layout is a browser/editor task, not a backend one; these abilities manage the template DATA (which emails are overridden, subjects, on/off, themes). |
wppilot/bricksforge-list-email-themesList Bricksforge Email Themes | Lists the saved Email Designer themes (id + name). A template binds to a theme by id (see bricksforge-edit-email-template use_theme/theme). Read-only: theme creation/design is a visual editor task. |
wppilot/bricksforge-list-popupsList Bricksforge Popups | Lists the Bricksforge popups (the brf_popups configs) in compact form: id, active, trigger, displayOn, template id, animation. Bricksforge popups are a distinct system from Bricks-core popup templates: content comes from a Bricks template, behaviour from this config. Use bricksforge-get-popup for one full config. |
wppilot/bricksforge-list-toolsList Bricksforge Tools | Lists the Bricksforge tools (feature modules such as Pro Forms, Popups, Maintenance Mode, Mega Menu) with their numeric ID, slug, name, active state, and whether the tool carries a settings blob in brf_tool_settings. Bricksforge stores activation as raw numeric IDs; this catalog is the ID-to-name map. Active IDs not in the catalog (from a newer Bricksforge) are reported in unknown_active_ids. |
Writes
Gated by the active profile and your WordPress capabilities. Rate limited to 120 per minute per credential.
| Ability | What it does |
|---|---|
wppilot/bricksforge-create-popupCreate Bricksforge Popup | Creates a Bricksforge popup with a generated id. Requires template (a Bricks template post id) and trigger; displayOn defaults to entire_website, active to true, overlay/body colors to the Bricksforge defaults. Returns the full stored config. The popup fires only while the Popups tool is enabled (warned otherwise). |
wppilot/bricksforge-disable-email-templateDisable Bricksforge Email Template | Deactivates an Email Designer template (status = inactive) so it stops overriding its emails; WordPress falls back to the default mail. The template and its design are kept — re-enable to restore it. |
wppilot/bricksforge-disable-toolDisable Bricksforge Tool | Deactivates one Bricksforge tool (feature module) by numeric id or slug. Writes the upstream brf_activated_tools option preserving its flat integer-array shape. Tool settings in brf_tool_settings and stored data (e.g. Pro Forms submissions) are NOT deleted — re-enabling restores the tool as it was. Already-inactive tools are a no-op. |
wppilot/bricksforge-duplicate-email-templateDuplicate Bricksforge Email Template | Deep-copies an existing Email Designer template into a new one with a fresh id, an inactive status, and NO overridden emails (its conditions are cleared so it does not fight the original). The visual body and theme binding are copied verbatim. Use this to base a new email on an existing design without opening the editor. |
wppilot/bricksforge-edit-email-templateEdit Bricksforge Email Template | Edits the METADATA of an Email Designer template in place (partial merge): name, subject, the emails it overrides (conditions), and its theme binding. Does NOT touch the visual body (canvas) — design that in a browser/editor. Setting conditions replaces the whole overrides list. Use bricksforge-enable/disable-email-template for the on/off status. |
wppilot/bricksforge-edit-popupEdit Bricksforge Popup | Edits a Bricksforge popup in place (partial merge update): only the provided keys change, every other stored key is preserved. The id cannot change. Returns the full updated config. |
wppilot/bricksforge-enable-elementEnable Bricksforge Custom Element | Activates one Bricksforge custom element (or element bundle — id 5 is the whole Pro Forms family) by numeric id or slug. Writes the upstream brf_activated_elements option preserving its array-of-objects shape and any per-element settings stored on other rows. The element registers in Bricks on the NEXT request — a bricks-list-elements call in this same conversation will already see it. Already-active elements are a no-op. |
wppilot/bricksforge-enable-email-templateEnable Bricksforge Email Template | Activates an Email Designer template (status = active) so it overrides the emails in its conditions. A template with no conditions is active but overrides nothing. Enabling one that overrides the same email as another means both fire — keep overrides unique. |
wppilot/bricksforge-enable-toolEnable Bricksforge Tool | Activates one Bricksforge tool (feature module) by numeric id or slug, e.g. pro-forms, popups, maintenance. Writes the upstream brf_activated_tools option preserving its flat integer-array shape. Already-active tools are a no-op. Note: the Pro Forms submissions table is still only created on the next wp-admin page load. |
Destructive
Marked destructive in the source, so each call needs an explicit confirmation flag, every time.
| Ability | What it does |
|---|---|
wppilot/bricksforge-delete-email-templateDelete Bricksforge Email Template | Permanently removes one Email Designer template by id (design and all). There is no trash. To stop it overriding emails without losing it, use bricksforge-disable-email-template instead. |
wppilot/bricksforge-delete-popupDelete Bricksforge Popup | Permanently removes a Bricksforge popup config by id (every stored row carrying that id, if duplicates exist). The Bricks template used as its content is NOT deleted. To pause a popup instead, edit it with active=false. |
wppilot/bricksforge-disable-elementDisable Bricksforge Custom Element | Deactivates one Bricksforge custom element (or element bundle) by numeric id or slug. Removes the element row from the upstream brf_activated_elements option, preserving every other row verbatim. WARNING: per-element settings stored on the removed row (e.g. Pro Forms captcha/Stripe keys on id 5, Font Awesome kit id on id 1) are removed with it — the same behaviour as deactivating in the Bricksforge UI. Existing pages keep the element in their saved Bricks tree but it stops rendering until re-enabled. |