Block Pattern Builder is a simple plugin that allows end-users to create custom block patterns within the WordPress plugin directory. The plugin currently requires Gutenberg 7.8+. Block patterns will be a part of core WordPress in the future. For now, Gutenberg is a hard requirement.
More information on block patterns can be found via the following links:
- Gutenberg 7.8 Adds Patterns API and Continues Interface Cleanup
- Block Patterns Will Change Everything
How to Use the Plugin
After installing and activating the plugin, you should see a new “Block Patterns” menu item in your WordPress admin. From that point, you can create a new pattern just like you would any post or page. The process is the same.
The idea with patterns is to create a reusable pattern or section of blocks that you will use later. Once you publish a pattern, it will be available within the pattern library.
Now, go to any post or page. Click on the pattern icon. At the time of writing, that icon is in the top right corner of the block editor, but this will surely change in future versions of Gutenberg and WordPress. After clicking on the icon, you should see your custom pattern in the pattern library/list. Click on it. It will be inserted into your post.
As of version 1.1.0, users can create a block pattern directly from the editor. Click on the “more options” button (ellipsis icon) in the editor toolbar with at least one block selected. Then, click the “Add to Block Patterns” option.
Why was this plugin created?
I thought it would be fun to build block patterns from the admin instead of writing code for them.
Block pattern is invalid. What should I do?
If this happens, something is off in the pattern. See if you can resolve the issue. Currently, block patterns are very early in development, so there is a distinct possibility of breakage.
Can I use this to build patterns for my theme?
Yes, certainly. You can build the patterns via the admin. Then, go to the code editor and copy the code version of the pattern. Then, register in your theme’s
register_pattern()function. This way, you can ship your custom patterns directly to your theme users.
Contributors & Developers
“Block Pattern Builder” is open source software. The following people have contributed to this plugin.Contributors
“Block Pattern Builder” has been translated into 2 locales. Thank you to the translators for their contributions.
Translate “Block Pattern Builder” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
The change log is located in the
changelog.md file in the plugin folder. You may also view the change log online.