A block pattern is a group of blocks, or a block with a predefined content and style.
If you would prefer to watch a video on this topic, I have recorded one for you here. A transcript is also available.
The purpose of a block pattern is to make it easier and faster to add common design elements and sections to a page or post.
Block patterns were added to WordPress in version 5.5.
If you have not updated WordPress yet, you can still use block patterns with the Gutenberg Plugin installed and activated.
In an earlier plugin version, patterns had their own sidebar panel, but they are now found in the Add Block menu in the upper left corner of the editor:
There are also a few example patterns available in version 5.5, that you can check out, like the two buttons above.
How to register a block pattern
To register a block pattern, themes and plugins can use the new PHP function called register_block_pattern.
Note that this function was renamed from register_pattern to register_block_pattern in Gutenberg version 8.1.
You can read the official documentation for the function here:
register_block_pattern accepts a name (prefix), a label, and an array with two required parameters: Title and content.
- Title is the name of the pattern that will be visible in the pattern selection panel.
- Content is the HTML source code of your block pattern.
There are four optional settings:
- Description -A visually hidden description that can describe the pattern to screen reader users.
- ViewportWidth -Sets the width of the pattern preview in the editor, for example if your pattern is very narrow, like a sidebar (int).
- Keywords -An array of words that can help users find your pattern in the block editor search. -Remember to make these words translatable for international sites.
- Categories -Block patterns are sorted under categories in the “add block” menu. Categories are optional. You can choose one or more of the following categories:
- Buttons
- Columns
- Gallery
- Header
- Text
Or, you can create your very own custom block pattern category using the PHP function register_block_pattern_category.
Example:
register_block_pattern_category(
'quotes',
array( 'label' => __( 'Quotes', 'textdomain' ) )
);
register_block_pattern(
'theme-prefix/block-pattern-label',
array(
'title' => __( 'Hello Quote', 'textdomain' ),
'categories' => array( 'quotes', 'text');
'content' => '<!-- wp:quote --><blockquote class="wp-block-quote hello-block"><p>Hello World of Blocks</p><cite>Carolina</cite></blockquote><!-- /wp:quote -->',
)
);The two categories; quotes and text, are placed inside an array.
To get the correct HTML code to use for your pattern, you can do the following:
- First, create your block pattern in the editor.
- Then open the editor toolbar, and select Code editor.
Locate your blocks, copy the code, and add it the content parameter in register_block_pattern.
<!-- wp:quote --><blockquote class="wp-block-quote hello-block"><p>Hello World of Blocks</p><cite>Carolina</cite></blockquote><!-- /wp:quote -->Since your HTML contains double quotes, “, make sure that the content is wrapped in single quotes, or that you replace the double quotes with \”. Otherwise your code will break.
-The preview of the block is created for you automatically.
You can find more code examples in this Gist.
Custom CSS and identifiers for block patterns
It is worth noting that block patterns have no identifier once they are added to your content.
Even though the patterns have a name and a label, these are not applied to the code.
If you wish to add specific styles, or if you want to be able to identify your block patterns on the front, make sure that you add a custom CSS class while creating the pattern.
Naming block patterns
The name and label of the block pattern must be unique, because otherwise you will overwrite other block patterns.
The title; the visible name of the block pattern, is not unique. So to help identify your patterns, I recommend that you include your brand name, plugin- or theme in the title.