WordPress at Your Fingertips
function is not described

WP_Block_Type_Registry::register() public WP 5.0.0

Registers a block type.

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

No Hooks.

Return

WP_Block_Type|false. The registered block type on success, or false on failure.

Usage

$WP_Block_Type_Registry = new WP_Block_Type_Registry();
$WP_Block_Type_Registry->register( $name, $args );
$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)
Array of block type arguments. Accepts any public property of WP_Block_Type. See WP_Block_Type::__construct() for information on accepted arguments.
Default: empty array

Notes

Changelog

Since 5.0.0 Introduced.

Code of WP_Block_Type_Registry::register() WP 5.9

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;
}