As the Gutenberg ecosystem matures, we get new tools and features to support the creating plugins.
One of the newest tools to create block plugins leverages npx command to scaffold a new block plugin.
The command is:
The script will ask the following questions:
- The block slug used for identification (also the plugin and output folder name)
- The internal namespace for the block name (something unique for your block)
- The display title for your block
- The short description for your block (optional)
- The dashicon to make it easier to identify your block (optional)
- The category name to help users browse and discover your block (use arrow keys)
- The name of the plugin author (optional). Multiple authors may be listed using commas
- The short name of the plugin’s license (optional)
A link to the full text of the license (optional)
The current version number of the plugin
The script will create a new folder with the following content:
package.jsonpackage configuration file
block.jsonblock configuration file
- All the basic dependencies for the block
@wordpress/scriptspackage to automate block-related tasks
- Access to the following commands
npm start: starts the build for development
npm run build: builds the code for production
npm run format: formats files
npm run lint:css: lints CSS files.
npm run packages-update: updates WordPress packages to the latest version
The next step is to change to the directory the plugin just created and run
npm-start to being working on the plugin.
You can now activate the plugin in your WordPress site and start working on your block.