register_block_pattern 注册自定义Pattern

文 / @UTHEME

函数功能

本函数用于将自定义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'=>__('Twobuttons','wpdocs-my-plugin'),
        'description'=>_x('Twohorizontalbuttons,theleftbuttonisfilledin,andtherightbuttonisoutlined.','Blockpatterndescription','wpdocs-my-plugin'),
        'content'=>"<!--wp:buttons{\"align\":\"center\"}-->\n<divclass=\"wp-block-buttonsaligncenter\"><!--wp:button{\"backgroundColor\":\"very-dark-gray\",\"borderRadius\":0}-->\n<divclass=\"wp-block-button\"><aclass=\"wp-block-button__linkhas-backgroundhas-very-dark-gray-background-colorno-border-radius\">".esc_html__('ButtonOne','wpdocs-my-plugin')."</a></div>\n<!--/wp:button-->\n\n<!--wp:button{\"textColor\":\"very-dark-gray\",\"borderRadius\":0,\"className\":\"is-style-outline\"}-->\n<divclass=\"wp-block-buttonis-style-outline\"><aclass=\"wp-block-button__linkhas-text-colorhas-very-dark-gray-colorno-border-radius\">".esc_html__('ButtonTwo','wpdocs-my-plugin')."</a></div>\n<!--/wp:button--></div>\n<!--/wp:buttons-->"
    )
);
添加UTHEME为好友
扫码添加UTHEME微信为好友
· 分享WordPress相关技术文章,主题上新与优惠动态早知道。
· 微信端最大WordPress社群,限时免费入群。