W3cubDocs

/WordPress

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

Registers a block type. The recommended way is to register a block type using the metadata stored in the block.json file.

Parameters

$block_typestring|WP_Block_Typerequired
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:array()

Return

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

Source

function register_block_type( $block_type, $args = array() ) {
	if ( is_string( $block_type ) && file_exists( $block_type ) ) {
		return register_block_type_from_metadata( $block_type, $args );
	}

	return WP_Block_Type_Registry::get_instance()->register( $block_type, $args );
}

Changelog

Version Description
5.8.0 First parameter now accepts a path to the block.json file.
5.0.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/register_block_type