WP_Block_Pattern_Categories_Registry::register() public WP 5.5.0

Registers a pattern category.

{} It's a method of the class: WP_Block_Pattern_Categories_Registry{}

No Hooks.

Return

true|false. True if the pattern was registered with success and false otherwise.

Usage

$WP_Block_Pattern_Categories_Registry = new WP_Block_Pattern_Categories_Registry();
$WP_Block_Pattern_Categories_Registry->register( $category_name, $category_properties );

$category_name(string) (required)

Pattern category name.

$category_properties(array) (required)

Array containing the properties of the category: label.

Changelog

Code of WP_Block_Pattern_Categories_Registry::register() WP Block Pattern Categories Registry::register ^{WP 5.7.2}

<?php
public function register( $category_name, $category_properties ) {
	if ( ! isset( $category_name ) || ! is_string( $category_name ) ) {
		_doing_it_wrong( __METHOD__, __( 'Block pattern category name must be a string.' ), '5.5.0' );
		return false;
	}

	$this->registered_categories[ $category_name ] = array_merge(
		array( 'name' => $category_name ),
		$category_properties
	);

	return true;
}