Note
The main
branch is only compatible with WordPress v6.6+.
them.es WordPress Blocks is a WordPress "Gutenberg" blocks boilerplate which can be included in a theme (or plugin).
- Gutenberg blocks configuration tested in WordPress v6.6+
- All legacy boilerplates have been archived in the following branches: WordPress <6.6 ("v2" branch) and WordPress <5.8 ("v1" branch)
- NPM configuration
- ESNext
- Support for a category where all custom blocks can be organized
- A simple "Hello world" block implementation is included
- Optional: Easily add more blocks
- Prerequisites: Node.js (NPM) needs to be installed on your system
- Download the source code of this repository to a new directory (e.g.
/blocks
) - Add the following code snippet to
functions.php
in your theme (or reference it in your plugin index file)
$theme_blocks = __DIR__ . '/blocks/index.php';
if ( is_readable( $theme_blocks ) ) {
require_once $theme_blocks;
}
- Open the
blocks
directory in Terminal and install the required Node.js dependencies: $ npm install
- A simple
Hello world
block implementation is included to get you started. More examples can be found in the official Gutenberg examples repository - You can include additional blocks by duplicating
/src/#####
- Run the
start
script: $ npm run start
- Develop the block(s) by modifying
/src/#####/index.js
- the official Gutenberg Handbook may help you learn how to build a custom block - When you're done run the
build
script to create a minified version of your blocks: $ npm run build
- Test the block(s) in the WordPress Editor
Code and Documentation © them.es
Code released under GPLv2+