HomeWebBlocks UIWebBlocks CMSCommerce GuidePluginsArticles

Technical reference

WebBlocks Forms documentation

Build structured forms, collect submissions on your own site and export the results.

Values below come from the current package manifest and Composer metadata.

Package identity

  • Handle: webblocks-forms
  • Version: 0.10.0
  • Type: CMS plugin
  • License: MIT

Runtime requirements

  • Current version: 0.10.0
  • Host product: WebBlocks CMS
  • CMS compatibility: ^1.81.0
  • PHP: >=8.3
  • License: MIT
  • Catalog status: Public catalog plugin

Installation is disabled-by-default and setup remains an explicit operator action.

  1. Open System → Plugins in a compatible WebBlocks CMS installation.
  2. Install the catalog release or upload its validated ZIP artifact.
  3. Review the manifest, compatibility and permissions before enabling it.
  4. Enable the plugin, then run explicit plugin setup or migrations when health reports that setup is required.
  5. Confirm plugin health and complete product-specific settings before exposing its public workflow.

Updates: review release notes and compatibility first. Package replacement must not silently enable the plugin or run migrations.

Inspectable behavior contributed to the host product.

Registered surfaces

  • Admin and public routes
  • Form page-builder block
  • Submission pruning command
  • Conditional-fields JavaScript

Permissions

  • webblocks-forms.view
  • webblocks-forms.manage
  • webblocks-forms.submissions
  • webblocks-forms.export
  • webblocks-forms.settings

The public contract describes ownership without exposing secrets or private implementation details.

Data ownership

Owns forms, fields, actions, submissions and private attachment records. Every submission stores a schema snapshot so later field edits do not rewrite historical meaning.

Security model

Attachments stay on a private plugin disk. Shared submission protection can allow, quarantine or mark spam before any configured action is run.

Disable and uninstall

Disabling makes plugin-owned routes, menus, blocks and behavior inert. Run migrations explicitly after compatible updates. Before uninstalling, export or back up plugin-owned data; package removal and data removal are separate lifecycle decisions.

Health and troubleshooting

Start with the plugin detail screen and health result. Confirm compatibility, required migrations, host services, scheduled commands and external-provider configuration before inspecting application logs.

What exists in the local package today, and what should be expanded next.

Current source set: README and changelog.

The README is detailed; split it into operator, privacy/data lifecycle and integration reference pages.