Title: WP_Block_Type_Registry Published: December 6, 2018 Last modified: April 28, 2025 --- # class WP_Block_Type_Registry {} ## In this article * [Methods](https://developer.wordpress.org/reference/classes/wp_block_type_registry/?output_format=md#methods) * [Source](https://developer.wordpress.org/reference/classes/wp_block_type_registry/?output_format=md#source) * [Changelog](https://developer.wordpress.org/reference/classes/wp_block_type_registry/?output_format=md#changelog) [ Back to top](https://developer.wordpress.org/reference/classes/wp_block_type_registry/?output_format=md#wp--skip-link--target) Core class used for interacting with block types. ## 󠀁[Methods](https://developer.wordpress.org/reference/classes/wp_block_type_registry/?output_format=md#methods)󠁿 | Name | Description | | [WP_Block_Type_Registry::__wakeup](https://developer.wordpress.org/reference/classes/wp_block_type_registry/__wakeup/) | – | | [WP_Block_Type_Registry::get_all_registered](https://developer.wordpress.org/reference/classes/wp_block_type_registry/get_all_registered/) | Retrieves all registered block types. | | [WP_Block_Type_Registry::get_instance](https://developer.wordpress.org/reference/classes/wp_block_type_registry/get_instance/) | Utility method to retrieve the main instance of the class. | | [WP_Block_Type_Registry::get_registered](https://developer.wordpress.org/reference/classes/wp_block_type_registry/get_registered/) | Retrieves a registered block type. | | [WP_Block_Type_Registry::is_registered](https://developer.wordpress.org/reference/classes/wp_block_type_registry/is_registered/) | Checks if a block type is registered. | | [WP_Block_Type_Registry::register](https://developer.wordpress.org/reference/classes/wp_block_type_registry/register/) | Registers a block type. | | [WP_Block_Type_Registry::unregister](https://developer.wordpress.org/reference/classes/wp_block_type_registry/unregister/) | Unregisters a block type. | ## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_block_type_registry/?output_format=md#source)󠁿 ```php final class WP_Block_Type_Registry { /** * Registered block types, as `$name => $instance` pairs. * * @since 5.0.0 * @var WP_Block_Type[] */ private $registered_block_types = array(); /** * Container for the main instance of the class. * * @since 5.0.0 * @var WP_Block_Type_Registry|null */ private static $instance = null; /** * Registers a block type. * * @since 5.0.0 * * @see WP_Block_Type::__construct() * * @param string|WP_Block_Type $name 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. * @param 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. * @return WP_Block_Type|false The registered block type on success, or false on failure. */ 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; } /** * Unregisters a block type. * * @since 5.0.0 * * @param string|WP_Block_Type $name Block type name including namespace, or alternatively * a complete WP_Block_Type instance. * @return WP_Block_Type|false The unregistered block type on success, or false on failure. */ public function unregister( $name ) { if ( $name instanceof WP_Block_Type ) { $name = $name->name; } if ( ! $this->is_registered( $name ) ) { _doing_it_wrong( __METHOD__, /* translators: %s: Block name. */ sprintf( __( 'Block type "%s" is not registered.' ), $name ), '5.0.0' ); return false; } $unregistered_block_type = $this->registered_block_types[ $name ]; unset( $this->registered_block_types[ $name ] ); return $unregistered_block_type; } /** * Retrieves a registered block type. * * @since 5.0.0 * * @param string|null $name Block type name including namespace. * @return WP_Block_Type|null The registered block type, or null if it is not registered. */ public function get_registered( $name ) { if ( ! $this->is_registered( $name ) ) { return null; } return $this->registered_block_types[ $name ]; } /** * Retrieves all registered block types. * * @since 5.0.0 * * @return WP_Block_Type[] Associative array of `$block_type_name => $block_type` pairs. */ public function get_all_registered() { return $this->registered_block_types; } /** * Checks if a block type is registered. * * @since 5.0.0 * * @param string|null $name Block type name including namespace. * @return bool True if the block type is registered, false otherwise. */ public function is_registered( $name ) { return isset( $name, $this->registered_block_types[ $name ] ); } public function __wakeup() { if ( ! $this->registered_block_types ) { return; } if ( ! is_array( $this->registered_block_types ) ) { throw new UnexpectedValueException(); } foreach ( $this->registered_block_types as $value ) { if ( ! $value instanceof WP_Block_Type ) { throw new UnexpectedValueException(); } } } /** * Utility method to retrieve the main instance of the class. * * The instance will be created if it does not exist yet. * * @since 5.0.0 * * @return WP_Block_Type_Registry The main instance. */ public static function get_instance() { if ( null === self::$instance ) { self::$instance = new self(); } return self::$instance; } } ``` [View all references](https://developer.wordpress.org/reference/files/wp-includes/class-wp-block-type-registry.php/) [View on Trac](https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/class-wp-block-type-registry.php#L16) [View on GitHub](https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/class-wp-block-type-registry.php#L16-L201) ## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_block_type_registry/?output_format=md#changelog)󠁿 | Version | Description | | [5.0.0](https://developer.wordpress.org/reference/since/5.0.0/) | Introduced. | ## User Contributed Notes You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_block_type_registry%2F) before being able to contribute a note or feedback.