WP_Block_Type_Registry::register( string|WP_Block_Type $name, array $args = array() ): WP_Block_Type|false
Registers a block type.
Description
See also
Parameters
-
$name
string|WP_Block_Type Required -
Block type name including namespace, or alternatively a complete WP_Block_Type instance. In case a WP_Block_Type is provided, the $args parameter will be ignored.
-
$args
array Optional -
Array of block type arguments. Accepts any public property of
WP_Block_Type
. See WP_Block_Type::__construct() for information on accepted arguments.More Arguments from WP_Block_Type::__construct( ... $args )
Array or string of arguments for registering a block type. Any arguments may be defined, however the ones described below are supported by default.
api_version
stringBlock API version.title
stringHuman-readable block type label.category
string|nullBlock type category classification, used in search interfaces to arrange block types by category.parent
string[]|nullSetting parent lets a block require that it is only available when nested within the specified blocks.ancestor
string[]|nullSetting ancestor makes a block available only inside the specified block types at any position of the ancestor's block subtree.icon
string|nullBlock type icon.description
stringA detailed block type description.keywords
string[]Additional keywords to produce block type as result in search interfaces.textdomain
string|nullThe translation textdomain.styles
array[]Alternative block styles.variations
array[]Block variations.selectors
arrayCustom CSS selectors for theme.json style generation.supports
array|nullSupported features.example
array|nullStructured data for the block preview.render_callback
callable|nullBlock type render callback.attributes
array|nullBlock type attributes property schemas.uses_context
string[]Context values inherited by blocks of this type.provides_context
string[]|nullContext provided by blocks of this type.editor_script_handles
string[]Block type editor only script handles.script_handles
string[]Block type front end and editor script handles.view_script_handles
string[]Block type front end only script handles.editor_style_handles
string[]Block type editor only style handles.style_handles
string[]Block type front end and editor style handles.
Default:
array()
Return
WP_Block_Type|false The registered block type on success, or false on failure.
Source
File: wp-includes/class-wp-block-type-registry.php
.
View all references
public function register( $name, $args = array() ) {
$block_type = null;
if ( $name instanceof WP_Block_Type ) {
$block_type = $name;
$name = $block_type->name;
}
if ( ! is_string( $name ) ) {
_doing_it_wrong(
__METHOD__,
__( 'Block type names must be strings.' ),
'5.0.0'
);
return false;
}
if ( preg_match( '/[A-Z]+/', $name ) ) {
_doing_it_wrong(
__METHOD__,
__( 'Block type names must not contain uppercase characters.' ),
'5.0.0'
);
return false;
}
$name_matcher = '/^[a-z0-9-]+\/[a-z0-9-]+$/';
if ( ! preg_match( $name_matcher, $name ) ) {
_doing_it_wrong(
__METHOD__,
__( 'Block type names must contain a namespace prefix. Example: my-plugin/my-custom-block-type' ),
'5.0.0'
);
return false;
}
if ( $this->is_registered( $name ) ) {
_doing_it_wrong(
__METHOD__,
/* translators: %s: Block name. */
sprintf( __( 'Block type "%s" is already registered.' ), $name ),
'5.0.0'
);
return false;
}
if ( ! $block_type ) {
$block_type = new WP_Block_Type( $name, $args );
}
$this->registered_block_types[ $name ] = $block_type;
return $block_type;
}
Changelog
Version | Description |
---|---|
5.0.0 | Introduced. |