HomeWebBlocks UIWebBlocks CMSCommerce GuidePluginsArticles

Technical reference

WebBlocks UI Manager documentation

Internal operator tooling for WebBlocks UI release metadata and first-party CDN artifact preparation.

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

Package identity

  • Handle: webblocks-ui-manager
  • Version: 0.2.0
  • Type: CMS plugin
  • License: MIT

Runtime requirements

  • Current version: 0.2.0
  • Host product: WebBlocks CMS
  • CMS compatibility: ^1.32
  • PHP: >=8.3
  • License: MIT
  • Catalog status: Internal operator tool

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 routes
  • Prepare and publish commands
  • Release/artifact/publish-run tables
  • Plugin health reporter

Permissions

  • webblocks-ui-manager.view
  • webblocks-ui-manager.manage
  • webblocks-ui-manager.publish

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

Data ownership

Owns release metadata, artifact manifests and publish-run records. It writes only to the configured first-party static root and never creates a mutable latest directory.

Security model

Manage and publish are deliberately separate permissions. Source and destination paths are bounded, symlink escapes are rejected and conflicting immutable files block publication.

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.

Adequate for internal use; clearly keep this out of the customer-install recommendation flow.