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 string
    Required. A human-readable label for the pattern category.

Top ↑

Return

bool True if the pattern category was registered with success and false otherwise.


Top ↑

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 );
}


Top ↑

Changelog

Changelog
Version Description
5.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    Contributed by Christina Blust

    Example from Block Editor Handbook:

    register_block_pattern_category(
        'hero',
        array( 'label' => __( 'Hero', 'wpdocs-my-plugin' ) )
    );

    These categories already exist in core as of 5.5.1:

    • buttons
    • columns
    • gallery
    • header
    • text
  2. Skip to note 3 content
    Contributed by Sajjad Hussain

    Another way to register custom block category with init hook

     function wpdocs_block_pattern_category() {
    	register_block_pattern_category( 'wpdocs-patterns', array(
    		'label' => __( 'My Patterns', 'text-domain' )
    	) );
    }
    
    add_action( 'init', 'wpdocs_block_pattern_category' );

You must log in before being able to contribute a note or feedback.