注册自定义Pattern
函数功能
注册自定义Pattern 到WordPress古腾堡编辑器。
函数参数
| 参数 | 数据类型 | 是否必需 | 描述 | 默认值 |
|---|---|---|---|---|
| $pattern_name | 字符串 | 是 | 包含命名空间的Pattern名称 | 无 |
| $pattern_properties | 数组 | 是 | 包含Pattern属性的数组。 | 无 |
$pattern_properties 数组可以包含以下几项数据。
| 参数 | 数据类型 | 是否必需 | 描述 |
|---|---|---|---|
| title | 字符串 | 是 | 模式标题 |
| content | 字符串 | 是 | 古腾堡编辑器的内容代码 |
| description | 字符串 | 否 | Pattern作用的详细说明 |
| categories | 字符串 | 否 | Pattern分类 |
| keywords | 字符串 | 否 | Pattern关键词，用于搜索 |
| viewportWidth | 字符串 | 否 | 在插入时指定Pattern的宽度 |
函数返回值
如果自定义Pattern注册成功，返回true，否则为false。
使用示例
下面的示例注册了一个包含两个按钮的自定义Pattern。数组中 content 的内容可以在古腾堡编辑器中编辑好后，切换到古腾堡编辑器的代码模式，直接复制代码过来。
register_block_pattern(
'wpdocs-my-plugin/my-awesome-pattern',
array(
'title' => __( 'Two buttons', 'wpdocs-my-plugin' ),
'description' => _x( 'Two horizontal buttons, the left button is filled in, and the right button is outlined.', 'Block pattern description', 'wpdocs-my-plugin' ),
'content' => "<!-- wp:buttons {"align":"center"} -->n<div class="wp-block-buttons aligncenter"><!-- wp:button {"backgroundColor":"very-dark-gray","borderRadius":0} -->n<div class="wp-block-button"><a class="wp-block-button__link has-background has-very-dark-gray-background-color no-border-radius">" . esc_html__( 'Button One', 'wpdocs-my-plugin' ) . "</a></div>n<!-- /wp:button -->nn<!-- wp:button {"textColor":"very-dark-gray","borderRadius":0,"className":"is-style-outline"} -->n<div class="wp-block-button is-style-outline"><a class="wp-block-button__link has-text-color has-very-dark-gray-color no-border-radius">" . esc_html__( 'Button Two', 'wpdocs-my-plugin' ) . "</a></div>n<!-- /wp:button --></div>n<!-- /wp:buttons -->",
)
);