register_block_pattern_category( string $category_name, array $category_properties ): bool
Registers a new pattern category.
Parameters
-
$category_name
string Required -
Pattern category name including namespace.
-
$category_properties
array Required -
List of properties for the block pattern.
See WP_Block_Pattern_Categories_Registry::register() for accepted arguments.More Arguments from WP_Block_Pattern_Categories_Registry::register( ... $category_properties )
List of properties for the block pattern category.
label
stringRequired. A human-readable label for the pattern category.
Return
bool True if the pattern category was registered with success and false otherwise.
Source
File: wp-includes/class-wp-block-pattern-categories-registry.php
.
View all references
function register_block_pattern_category( $category_name, $category_properties ) {
return WP_Block_Pattern_Categories_Registry::get_instance()->register( $category_name, $category_properties );
}
Changelog
Version | Description |
---|---|
5.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example from Block Editor Handbook:
These categories already exist in core as of 5.5.1:
Top ↑
Feedback
Now also available featured and query — By thejaydip —
To get the list of all registered categories, paste into the js inspector:
Another way to register custom block category with init hook
From Block editor handbook:
register_block_pattern_category()
should be called from a handler attached to the init hook.