WP_Block_Pattern_Categories_Registry::register()
Registers a pattern category.
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 including namespace.
- $category_properties(array) (required)
List of properties for the block pattern category.
- label(string)
Required. A human-readable label for the pattern category.
- label(string)
Changelog
Since 5.5.0 | Introduced. |
WP_Block_Pattern_Categories_Registry::register() WP Block Pattern Categories Registry::register code WP 6.4.3
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; } $category = array_merge( array( 'name' => $category_name ), $category_properties ); $this->registered_categories[ $category_name ] = $category; // If the category is registered inside an action other than `init`, store it // also to a dedicated array. Used to detect deprecated registrations inside // `admin_init` or `current_screen`. if ( current_action() && 'init' !== current_action() ) { $this->registered_categories_outside_init[ $category_name ] = $category; } return true; }