unregister_block_pattern()
云策文档标注
概述
unregister_block_pattern() 函数用于注销一个已注册的区块模式。它接受区块模式名称作为参数，并返回操作是否成功的布尔值。
关键要点
- 参数 $pattern_name 是必需的字符串，需包含命名空间（如 'core/query-standard-posts'）。
- 返回值为布尔类型：成功注销返回 true，否则返回 false。
- 该函数内部调用 WP_Block_Patterns_Registry::get_instance()->unregister() 方法实现注销功能。
- 自 WordPress 5.5.0 版本引入。
代码示例
// 示例代码：移除特定模式
unregister_block_pattern( 'wpdocs-plugin/wpdocs-columns-list' );
// 示例代码：移除核心注册的多个模式
add_action( 'init', 'wpdocs_remove_core_patterns' );
function wpdocs_remove_core_patterns() {
$core_block_patterns = array(
'query-standard-posts',
'query-medium-posts',
'query-small-posts',
'query-grid-posts',
'query-large-title-posts',
'query-offset-posts',
'social-links-shared-background-color',
);
foreach ( $core_block_patterns as $core_block_pattern ) {
unregister_block_pattern( 'core/' . $core_block_pattern );
}
}
原文内容
Unregisters a block pattern.
Parameters
$pattern_namestringrequired-
Block pattern name including namespace.
Source
function unregister_block_pattern( $pattern_name ) {
return WP_Block_Patterns_Registry::get_instance()->unregister( $pattern_name );
}
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Introduced. |
Skip to note 2 content
Manish Songirkar
Example code to remove pattern,
unregister_block_pattern( 'wpdocs-plugin/wpdocs-columns-list' );Example code to remove specific patterns registered in core,
add_action( 'init', 'wpdocs_remove_core_patterns' ); function wpdocs_remove_core_patterns() { $core_block_patterns = array( 'query-standard-posts', 'query-medium-posts', 'query-small-posts', 'query-grid-posts', 'query-large-title-posts', 'query-offset-posts', 'social-links-shared-background-color', ); foreach ( $core_block_patterns as $core_block_pattern ) { unregister_block_pattern( 'core/' . $core_block_pattern ); } }