- We follow the WordPress Coding Standards when developing for this plugin, there should be no errors or warnings when using the phpcs.xml.dist ruleset.
- There can be NO breaking changes, backwards compatibility is important!
- There should be no dependencies on any paid third party code (plugin and/or package).
- There should preferably be as least as possible dependencies on any third party code.
- If there is a dependency it should preferably be included within the plugin (if necessary via build command).
- If there is a dependency and the dependency is missing the code should not break (no fatal errors!), so check for the presence of the dependency and if necessary show an Admin notification.
- A stable release of the plugin should be installable without the need for any build commands (like
npm run build) - In the first version of this plugin we do not include custom post types and/or taxonomies. Any block that relies on a custom post type and/or taxonomy should be moved to a separate plugin/addon.
- This plugin is a joined effort between Acato and Draad. Additions to this plugin should be approved by both parties.
- A block should consist of:
block.jsonfor all metadata of the block;index.jsto register the block;class-[block-name].php, eq toclass-button-group.phpto extend the Base_Block;template.phpas the render for the frontend;/assets/directory withstylesandscripts(and other assets likeicons);/scripts/directory contains:edit.js(required) edit script;save.js(optional), this is based on how the block is saved in WordPress, required if we want Yoast SEO to recognize fields;client.js(optional), Javascript file for the clients. Must be defined inblock.json;- directories like
controlsfor the controls; - directories like
componentsfor (preview) components and other scripts;
/styles/directory contains:style.scss: (optional), styles for the frontend and editor, must be defined inblock.json.editor.scss: (optional), pure styles for the editor. Must be defined inblock.json;