function function
注册自定义Pattern 到WordPress古腾堡编辑器。
function parameter
| parameters | data type | Required or not | descriptive | default value |
|---|---|---|---|---|
| $pattern_name | string (computer science) | be | 包含命名空间的Pattern名称 | not have |
| $pattern_properties | arrays | be | 包含Pattern属性的数组。 | not have |
$pattern_properties 数组可以包含以下几项数据。
| parameters | data type | Required or not | descriptive |
|---|---|---|---|
| title | string (computer science) | be | 模式标题 |
| content | string (computer science) | be | 古腾堡编辑器的内容代码 |
| description | string (computer science) | clogged | Pattern作用的详细说明 |
| categories | string (computer science) | clogged | Pattern分类 |
| keywords | string (computer science) | clogged | Pattern关键词，用于搜索 |
| viewportWidth | string (computer science) | clogged | 在插入时指定Pattern的宽度 |
Function Return Value
如果自定义Pattern注册成功，返回true，否则为false。
usage example
下面的示例注册了一个包含两个按钮的自定义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 -->\n\n<!-- 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 -->",
)
);
