https://github.com/doubleedesign/comet-plugin
WordPress plugin implementing the Comet Components library and associated block editor customisations.
https://github.com/doubleedesign/comet-plugin
php php8 ui-components wordpress wordpress-plugin
Last synced: about 1 year ago
JSON representation
WordPress plugin implementing the Comet Components library and associated block editor customisations.
- Host: GitHub
- URL: https://github.com/doubleedesign/comet-plugin
- Owner: doubleedesign
- Created: 2025-04-14T10:17:50.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-31T08:05:38.000Z (about 1 year ago)
- Last Synced: 2025-05-31T10:50:58.163Z (about 1 year ago)
- Topics: php, php8, ui-components, wordpress, wordpress-plugin
- Language: PHP
- Homepage: https://www.cometcomponents.io
- Size: 391 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Comet Components WordPress plugin
This plugin is a WordPress implementation of the majority of Double-E Design's Comet Components library and standard customisations of the block editor itself. It includes the majority of the components as blocks, as well as some designed for use directly in templates (such as `SiteHeader`, `SiteFooter`, and `Menu`). The blocks are a combination of supported core blocks (some with customisations) and custom blocks.
This plugin is a foundational requirement for all Double-E Design themes developed for the block editor from December 2024.
If you're reading this from GitHub, you're seeing the mirror of the [Comet Components WordPress Plugin package](https://github.com/doubleedesign/comet-components/tree/master/packages/comet-plugin) that is here for the purposes of publishing to Packagist and installing via Composer.
Development of this project belongs in the main Comet Components monorepo.
---
## Developer notes
### File structure
Due to the way that some things for the block editor can be done in PHP and others must be done in JavaScript, some of
the code organisation feels a bit unintuitive because there can be code in either language that deals with the same
domain. The following table outlines the purpose of each core file or pair of files in this plugin.
| PHP file | JS or other file | Purpose |
|--------------------------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `JavaScriptImplementation.php` | - | Provides an explicit structure for pairing PHP and JS files that do related things, and handles enqueueing of the JS file in the WordPress admin. |
| `BlockRegistry.php` | `block-registry.js` | Manages block registration, block availability, supported features, styles, and variations. |
| `BlockRenderer.php` | | Handles intercepting front-end core block rendering to insert Comet Components, transforming of block attributes and/or output to suit Comet structures, processing of inner blocks to render as Comet components (including handling of non-core blocks provided by the plugin), and related functions. |
| `BlockEditorConfig.php` | `block-editor-config.js` | Customisations to the organisation of blocks in the editor such as categorisation, labels and descriptions, and restrictions on parent/child block relationships; customisations to the editor itself such as disabling unwanted/unsupported editor features and customising editor behaviour e.g., sidebar/panel appearance. |
| `BlockEditorAdminAssets.php` | - | Handles loading of shared JS and CSS files in the block editor such as global CSS. |
| - | `block-support.json` | Centralised reference for supported core blocks, categorisation, etc. Imported into the above files as appropriate. |