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

$namestring|WP_Block_Typerequired
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.
$argsarrayoptional
Array of block type arguments. Accepts any public property of WP_Block_Type. See WP_Block_Type::__construct() for information on accepted arguments.

Default:array()

Return

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

Source

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

VersionDescription
5.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.