WP_Block_Pattern_Categories_Registry::register( string $category_name, array $category_properties ): bool
Registers a pattern category.
Parameters
-
$category_name
string Required -
Pattern category name including namespace.
-
$category_properties
array Required -
List of properties for the block pattern category.
label
stringRequired. A human-readable label for the pattern category.
Return
bool True if the pattern was registered with success and false otherwise.
Source
File: wp-includes/class-wp-block-pattern-categories-registry.php
.
View all references
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;
}
Changelog
Version | Description |
---|---|
5.5.0 | Introduced. |