wpseek.com
A WordPress-centric search engine for devs and theme authors



register_block_type › WordPress Function

Since5.0.0
Deprecatedn/a
› register_block_type ( $block_type, $args = array() )
Parameters: (2)
  • (string|WP_Block_Type) $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.
    Required: Yes
  • (array) $args Optional. 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.
    Required: No
    Default: array()
Returns:
  • (WP_Block_Type|false) The registered block type on success, or false on failure.
Defined at:
Codex:
Change Log:
  • 5.8.0

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



Related Functions: unregister_block_type, register_block_style, unregister_block_style, register_block_pattern, register_block_template

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

	/** @var (lowercase-string&non-falsy-string)|WP_Block_Type $block_type A string that is not a path to block metadata should be a block type name. */
	return WP_Block_Type_Registry::get_instance()->register( $block_type, $args );
}