函数文档

unregister_block_type()

💡 云策文档标注

概述

unregister_block_type() 函数用于注销一个已注册的块类型,通常在 WordPress 块编辑器开发中用于移除自定义块。

关键要点

  • 参数 $name 可以是字符串(包含命名空间的块类型名称)或 WP_Block_Type 实例。
  • 返回值:成功时返回被注销的 WP_Block_Type 对象,失败时返回 false。
  • 该函数内部调用 WP_Block_Type_Registry::get_instance()->unregister() 实现注销功能。
  • 自 WordPress 5.0.0 版本引入。

代码示例

// Unregisters block type `my_namespace/my_block`.
unregister_block_type( 'my_namespace/my_block' );

📄 原文内容

Unregisters a block type.

Parameters

$namestring|WP_Block_Typerequired
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.

Source

function unregister_block_type( $name ) {
	return WP_Block_Type_Registry::get_instance()->unregister( $name );
}

Changelog

Version Description
5.0.0 Introduced.

User Contributed Notes