WP_Block_Type_Registry::register( string|WP_Block_Type $name, array $args = array() ): WP_Block_Type|false

Registers a block type.


Description

Top ↑

See also


Top ↑

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_versionstring
    Block API version.
  • titlestring
    Human-readable block type label.
  • categorystring|null
    Block type category classification, used in search interfaces to arrange block types by category.
  • parentarray|null
    Setting parent lets a block require that it is only available when nested within the specified blocks.
  • ancestorarray|null
    Setting ancestor makes a block available only inside the specified block types at any position of the ancestor's block subtree.
  • iconstring|null
    Block type icon.
  • descriptionstring
    A detailed block type description.
  • keywordsstring[]
    Additional keywords to produce block type as result in search interfaces.
  • textdomainstring|null
    The translation textdomain.
  • stylesarray
    Alternative block styles.
  • variationsarray
    Block variations.
  • supportsarray|null
    Supported features.
  • examplearray|null
    Structured data for the block preview.
  • render_callbackcallable|null
    Block type render callback.
  • attributesarray|null
    Block type attributes property schemas.
  • uses_contextarray
    Context values inherited by blocks of this type.
  • provides_contextarray|null
    Context provided by blocks of this type.
  • editor_scriptstring|null
    Block type editor only script handle.
  • scriptstring|null
    Block type front end and editor script handle.
  • view_scriptstring|null
    Block type front end only script handle.
  • editor_stylestring|null
    Block type editor only style handle.
  • stylestring|null
    Block type front end and editor style handle.

Default: array()


Top ↑

Return

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


Top ↑

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


Top ↑

Changelog

Changelog
Version Description
5.0.0 Introduced.

Top ↑

User Contributed Notes

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