register_block_type( string|WP_Block_Type $block_type, array $args = array() ): WP_Block_Type|false

Parameters

$block_typestring|WP_Block_Type

Block type name including namespace, or alternatively a path to the JSON file with metadata definition for the block, or a path to the folder where the block.json file is located, or 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 empty array.Default: array()

Return

WP_Block_Type|false

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

Uses · 3

• register_block_type_from_metadata()Registers a block type from the metadata stored in the `block.json` file.
• WP_Block_Type_Registry::get_instance()::register()
• WP_Block_Type_Registry::get_instance()Utility method to retrieve the main instance of the class.

Used by · 1

• register_legacy_post_comments_block()Ensures backwards compatibility for any users running the Gutenberg plugin who have used Post Comments before it was merged into Comments Query Loop.

Source

View on Trac ↗View on GitHub ↗

842function register_block_type( $block_type, $args = array() ) {843	if ( is_string( $block_type ) && file_exists( $block_type ) ) {844		return register_block_type_from_metadata( $block_type, $args );845	}846 847	return WP_Block_Type_Registry::get_instance()->register( $block_type, $args );848}

History

Introduced in 5.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/blocks.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.