GC_Block_Type_Registry::register()
最后更新于:2021-11-26 11:23:27
GC_Block_Type_Registry::register( string|GC_Block_Type$name, array$args=array())Registers a block type.
参数
- $name
-
(string|GC_Block_Type) (Required) Block type name including namespace, or alternatively a complete GC_Block_Type instance. In case a GC_Block_Type is provided, the $args parameter will be ignored.
- $args
-
(array) (Optional) Array of block type arguments. Accepts any public property of
GC_Block_Type
. See GC_Block_Type::__construct() for information on accepted arguments.Default value: array()
响应
(GC_Block_Type|false) The registered block type on success, or false on failure.
源文件
文件: gc-includes/class-gc-block-type-registry.php
public function register( $name, $args = array() ) {
$block_type = null;
if ( $name instanceof GC_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 GC_Block_Type( $name, $args );
}
$this->registered_block_types[ $name ] = $block_type;
return $block_type;
}