WordPress开发手册:register_block_pattern()

函数原型

register_block_pattern( string $pattern_name, array $pattern_properties ): bool

函数描述

是否弃用

未弃用

函数参数

$pattern_name
string
Required

Block pattern name including namespace.

$pattern_properties
array
Required

List of properties for the block pattern.
See WP_Block_Patterns_Registry::register() for accepted arguments.

More Arguments from WP_Block_Patterns_Registry::register( … $pattern_properties )

List of properties for the block pattern.

• title string
  Required. A human-readable title for the pattern.
• content string
  Required. Block HTML markup for the pattern.
• description string
  Optional. Visually hidden text used to describe the pattern in the inserter. A description is optional, but is strongly encouraged when the title does not fully describe what the pattern does. The description will help users discover the pattern while searching.
• viewportWidth int
  Optional. The intended width of the pattern to allow for a scaled preview within the pattern inserter.
• categories array
  Optional. A list of registered pattern categories used to group block patterns. Block patterns can be shown on multiple categories.
  A category must be registered separately in order to be used here.
• blockTypes array
  Optional. A list of block names including namespace that could use the block pattern in certain contexts (placeholder, transforms).
  The block pattern is available in the block editor inserter regardless of this list of block names.
  Certain blocks support further specificity besides the block name (e.g. for core/template-part you can specify areas like core/template-part/header or core/template-part/footer).
• keywords array
  Optional. A list of aliases or keywords that help users discover the pattern while searching.

函数返回值

函数位置

函数源码

function register_block_pattern( $pattern_name, $pattern_properties ) {
	return WP_Block_Patterns_Registry::get_instance()->register( $pattern_name, $pattern_properties );
}

源码链接

WordPress
Github

变更日志