支架

块支持是允许块声明对某些功能的支持的API。

选择这些特性中的任何一个都会在块上注册其他属性,并提供UI来操作该属性。

为了将属性应用于块,生成的属性被添加到块的包装元素中。它们被添加到从使用块属性挂钩。

块编辑功能:

函数BlockEdit(){const blockProps=使用块属性();return<div{…blockProps}>你好,世界</div>;}

节约功能:

函数BlockEdit(){const blockProps=useBlockProps.save();return<div{…blockProps}>你好世界</div>;}

对于通过渲染器回调在PHP中,您可以使用获取块包装属性()功能。它返回一个包含所有生成属性的字符串,需要在包装块元素的开始标记中获得输出。

渲染器回调功能:

函数render_block(){$wrapper_attributes=获取块包装属性();回程冲刺(“<div%1$s>%2$s</div>”,$wrapper_attributes,“你好,世界!”);}

  • 类型:布尔值
  • 默认值:

锚可以让您直接链接到页面上的特定块。此属性添加一个字段来定义块的id,并添加一个按钮来复制直接链接。重要提示:它还不能用于动态块。

//声明对锚链接的支持。支架:{锚:true}

排列

  • 类型:布尔值阵列
  • 默认值:

此特性添加块控件,以允许更改块的对齐方式。

支持:{//声明支持块对齐。//这增加了对所有选项的支持://左、中、右、宽、全。对齐:true}
支持:{//声明对特定对齐选项的支持。align:['left','right','full']}

当块声明支持排列,属性定义被扩展为包含带有一串类型。默认情况下,不指定路线。块可以通过指定自己的默认对齐方式排列属性设置为默认值。例如:

属性:{对齐:{type:'字符串',默认值:“right”}}

对齐宽

  • 类型:布尔值
  • 默认值:真的

此属性允许启用宽对齐你的主题。要禁用单个块的此行为,请将此标志设置为.

支架:{//拆下支架以进行广泛对齐。alignWide:假}

aria标签

  • 类型:布尔值
  • 默认值:

ARIA标签允许您为元素定义一个可访问的标签。此属性允许为块启用aria-label的定义,而无需公开UI字段。

支架:{//添加对aria标签的支持。ariaLabel:真}

背景

注:从WordPress 6.5开始。

  • 类型:对象
  • 默认值:无效的
  • 子属性
    • 背景图像:类型布尔值,默认值
    • 背景大小:类型布尔值,默认值

此值表示块支持一些与背景相关的CSS样式属性。当它这样做时,块编辑器将显示UI控件,供用户设置其值,如果主题声明支持.

背景图像添加允许用户选择背景图像的UI控件。
背景大小添加FocalPointPicker以拾取背景图像的位置,并允许用户选择背景大小(cover、contain、fixed)。

支架:{背景:{backgroundImage:true//启用背景图像控件。backgroundSize:true//启用背景图像+大小控制。}}

当块声明支持特定的背景属性时,其属性定义将扩展为包括风格属性。

选择背景图像后,图像数据存储在style.background.backgoundImage(样式背景图像).

选择背景图像并更改其位置或大小时,背景位置存储在style.background.backgoundPosition(样式.背景.背景位置)及其背景尺寸样式.背景.背景大小属性。

  • 风格:的属性对象未指定默认值的类型。这是在以下情况下添加的背景图像背景大小声明支持。它存储用户设置的自定义值。
    • 背景:的属性对象类型。
      • 背景图像:的属性对象类型,包含有关所选图像的信息
        • 网址:类型一串,图像的URL
        • 身份证件:类型整数,媒体附件ID
        • 来源:类型一串,目前唯一的值是文件
        • 标题:类型一串,媒体附件的标题
      • 背景位置:的属性一串类型,定义背景图像位置,由FocalPointPicker选择并在CSS中用作背景位置值。
      • 背景大小:的属性一串类型。定义CSS背景尺寸值。

块可以通过使用默认值指定其自身属性来应用默认背景图像、位置和大小。例如:

属性:{样式:{背景:{背景图片:{“url”:“IMAGE_url”}背景位置:“50%50%”,backgroundSize:“封面”}}}

类名

  • 类型:布尔值
  • 默认值:真的

默认情况下,类.wp-块-块-名称添加到已保存标记的根元素中。这有助于为主题和插件可以依赖的样式块提供一致的机制。如果出于任何原因,标记上不需要类,则可以禁用此功能。

支架:{//删除对生成的className的支持。类名称:false}

颜色

  • 类型:对象
  • 默认值:null
  • 子属性:
    • 背景:类型布尔值,默认值真的
    • 按钮:类型布尔值,默认值
    • 启用对比检查器:类型布尔值,默认值真的
    • 梯度:类型布尔值,默认值
    • 标题:类型布尔值,默认值
    • 链接:类型布尔值,默认值
    • 文本:类型布尔值,默认值真的

此值表示块支持某些与颜色相关的属性。当该值存在时,块编辑器将显示UI控件,供用户设置其值。

请注意背景文本键的默认值为真的,所以如果颜色属性存在时,它们也将被视为已启用:

支架:{颜色:{//这还启用了文本和背景UI控件。gradients:true//启用gradients UI控件。}}

可以单独禁用它们:

支架:{color:{//文本UI控件已启用。background:false,//禁用后台UI控件。gradients:true//启用gradients UI控件。}}

颜色背景

此属性添加UI控件,允许用户将纯色背景应用于块。

声明颜色支持时,默认情况下会启用此属性(以及文本),因此只需设置颜色即可启用背景色。

支架:{color:true//启用背景和文本颜色支持。}

要在启用其他颜色支持的同时禁用背景支持,请将设置为.

支架:{颜色:{//禁用后台支持。文本颜色支持仍处于启用状态。背景:假}}

当块声明支持颜色背景,属性定义被扩展为包括两个新属性:背景色风格:

  • 背景色:的属性一串未指定默认值的类型。

    当用户从预设背景颜色列表中进行选择时,预设段塞存储在背景色属性。

    背景色预设源于编辑彩色剧本 主题支持.

    块可以通过使用默认值指定其自身属性来应用默认预设背景色。例如:

    属性:{背景颜色:{type:'字符串',默认值:“some-preset-background-slug”,}}
  • 风格:的属性对象未指定默认值的类型。

    选择自定义背景色时(即使用自定义颜色选择器),自定义颜色值存储在样式.颜色.背景属性。

    块可以通过使用默认值指定其自身属性来应用默认自定义背景色。例如:

    属性:{样式:{type:'对象',默认值:{颜色:{背景:“#aabbcc”,}}}}

彩色按钮

注:从WordPress 6.5开始。

此属性添加块控件,允许用户设置块中的按钮颜色(文本、背景)。默认情况下禁用按钮颜色。

要启用按钮颜色支持,请设置颜色按钮真的.

支架:{颜色:{按钮:true}}

按钮颜色预设源于编辑彩色剧本 主题支持.

当块声明支持颜色按钮,属性定义扩展为包括风格属性:

  • 风格:的属性对象未指定默认值的类型。

    选择按钮颜色时,颜色值存储在样式.elements.button.color.textstyle.elements.button.color.background样式元素按钮颜色背景属性。

    块可以通过使用默认值指定其自身属性来应用默认按钮颜色。例如:

    属性:{样式:{type:'对象',默认值:{元素:{按钮:{颜色:{text:'变量:预设|颜色|对比度',背景:'#000000',}}}}}}

颜色启用对比检查器

注:从WordPress 6.5开始。

确定对比度检查器小部件是否显示在块编辑器UI中。

只有当块声明支持颜色时,才会显示对比度检查器。它测试颜色组合的可读性,并警告是否存在潜在问题。默认情况下启用该属性。设置为要明确禁用:

支架:{颜色:{enableContrastChecker:false}}

颜色__实验双色调

注:自WordPress 6.3以来已弃用。

此属性已被替换过滤器.uotone.

颜色.渐变

此属性添加允许用户将渐变背景应用于块的UI控件。

支架:{颜色:{渐变:真,//如果不想将默认值与渐变一起使用,则必须禁用默认值。背景:假,文本:false}}

渐变预设源于编辑器粒度预设 主题支持.

当块声明支持颜色.渐变,属性定义扩展为包括两个新属性:梯度风格:

  • 梯度:的属性一串未指定默认值的类型。

    当用户从预设梯度列表中进行选择时,预设段塞将存储在梯度属性。

    块可以通过使用默认值指定自己的属性来应用默认预设渐变。例如:

    属性:{梯度:{type:'字符串',默认值:“some-preset-gradient-slug”,}}
  • 风格:的属性对象未指定默认值的类型。

    选择自定义渐变时(即使用自定义渐变选择器),自定义渐变值存储在样式.颜色.渐变属性。

    块可以通过使用默认值指定自己的属性来应用默认自定义渐变。例如:

    属性:{样式:{type:'对象',默认值:{颜色:{gradient:'线性-梯度(135度,rgb(170187204)0%,rgp(17,34,51)100%)',}}}}

颜色。标题

注:从WordPress 6.5开始。

此属性添加允许用户设置块中标题颜色的块控件。默认情况下禁用标题颜色。

要启用标题颜色支持,请设置颜色。标题真的.

支架:{颜色:{//启用标题颜色支持。标题:true}}

标题颜色预设源于编辑彩色剧本 主题支持.

当块声明支持颜色.标题,属性定义扩展为包括风格属性:

  • 风格:的属性对象未指定默认值的类型。

    选择标题颜色后,颜色值存储在样式.元素.标题.颜色.textstyle.elements.heading.color.background样式.元素.标题.颜色.背景属性。

    块可以通过使用默认值指定其自身属性来应用默认标题颜色。例如:

    属性:{样式:{type:'对象',默认值:{元素:{标题:{颜色:{text:'变量:预设|颜色|对比度',背景:'#000000',}}}}}}

此属性添加允许用户设置块中链接颜色的块控件。默认情况下,链接颜色处于禁用状态。

要启用链接颜色支持,请设置颜色链接真的.

支架:{颜色:{链接:true}}

链接颜色预设来源于编辑彩色剧本 主题支持.

当块声明支持颜色链接,属性定义扩展为包括风格属性:

  • 风格:的属性对象未指定默认值的类型。

    选择链接颜色后,颜色值存储在样式.elements.link.color.textstyle.elements.link.:悬停.颜色.text属性。

    块可以通过使用默认值指定其自身属性来应用默认链接颜色。例如:

    属性:{样式:{type:'对象',默认值:{元素:{链接:{颜色:{text:'变量:预设|颜色|对比度',},“:悬停”:{颜色:{文本:“#000000”}}}}}}}

颜色.text

此属性添加允许用户设置块中文本颜色的块控件。

声明颜色支持时,默认情况下会启用此属性(以及背景),因此只需设置颜色即可启用文本颜色。

支架:{color:true//启用背景和文本,但不启用链接。}

要在启用其他颜色支持的同时禁用文本颜色支持,请设置颜色.text.

支架:{颜色:{//禁用文本颜色支持。文本:false}}

文本颜色预设源于编辑彩色剧本 主题支持.

当块声明支持颜色.text,属性定义扩展为包括两个新属性:文本颜色风格:

  • 文本颜色:的属性一串未指定默认值的类型。

    当用户从预设文本颜色列表中选择时,预设段塞存储在文本颜色属性。

    块可以通过使用默认值指定其自身属性来应用默认预设文本颜色。例如:

    属性:{text颜色:{类型:“字符串”,默认值:“some-preset-text-color-slug”,}}
  • 风格:的属性对象未指定默认值的类型。

    选择自定义文本颜色时(即使用自定义颜色选择器),自定义颜色值存储在样式.颜色.text属性。

    块可以通过使用默认值指定其自身属性来应用默认自定义文本颜色。例如:

    属性:{样式:{type:'对象',默认值:{颜色:{文本:“#aabbcc”,}}}}

自定义类名

  • 类型:布尔值
  • 默认值:真的

此属性添加一个字段来定义块包装器的自定义className。

支架:{//删除对自定义className的支持。customClassName:false}

尺寸

注:从WordPress 6.2开始。

  • 类型:对象
  • 默认值:null
  • 子属性:
    • 最小高度:类型布尔值,默认值

此值表示块支持一些与标注相关的CSS样式属性。当它这样做时,块编辑器将显示UI控件,供用户设置其值,如果主题声明支持.

支架:{尺寸:{aspectRatio:true//启用纵横比控制。minHeight:true//启用最小高度控制。}}

当块声明支持特定维度属性时,其属性定义将扩展为包括风格属性。

  • 风格:的属性对象未指定默认值的类型。这是在以下情况下添加的纵横比最小高度宣布支持。它存储用户设置的自定义值。例如:
属性:{样式:{尺寸:{纵横比:“16/9”,最小高度:“50vh”}}}

滤波器

  • 类型:对象
  • 默认值:null
  • 子属性:
    • 双色调:类型布尔值,默认值

此值表示块支持与过滤器相关的某些属性。这样,块编辑器将显示UI控件,供用户设置其值。

过滤器.uotone

此属性添加允许用户将双音过滤器应用于的UI控件
一块或一块的一部分。

支架:{过滤器:{//启用双音支持双音:真}},选择器:{过滤器:{//将过滤器应用于图像块内的img元素双色调:'.wp-block-image img'}}

通过设置选择器.过滤器.音调选择器。

双色预设源于颜色.色调在里面主题.json.

当块声明支持过滤器.uotone,属性定义扩展为包括属性风格:

  • 风格:的属性对象未指定默认值的类型。

    块可以通过使用默认值指定其自身属性来应用默认双色调颜色。例如:

    属性:{样式:{type:'对象',默认值:{颜色:{双音:[“#FFF”,'#000']}}}}

html格式

  • 类型:布尔值
  • 默认值:真的

默认情况下,可以单独编辑块的标记。要禁用此行为,请设置html格式.

支架:{//删除对HTML模式的支持。html:错误}

插入器

  • 类型:布尔值
  • 默认值:真的

默认情况下,所有块都将显示在插入器、块转换菜单、样式表等中。要从用户界面的所有部分隐藏块,以便只能通过编程方式插入,请设置插入器.

支架:{//从插入器中隐藏此块。插入器:false}

互动性

  • 类型:布尔值对象
  • 默认值:
  • 子属性:
    • 客户端导航:类型布尔值,默认值
    • 交互式:类型布尔值,默认值

指示块是否正在使用交互API功能。

这个客户端导航子属性指示块是否与Interactivity API客户端导航兼容。
仅当块不是交互式的或使用Interactivity API进行交互时,才将其设置为true。如果块是交互式的,但使用普通JS、jQuery或除交互API之外的其他JS框架/库,则将其设置为false。

这个交互式sub属性指示块是否正在使用Interactivity API指令。

布局

  • 类型:布尔值对象
  • 默认值:null
  • 子属性:
    • 违约:类型对象,默认值为null
    • 允许切换:类型布尔值,默认值
    • 允许编辑:类型布尔值,默认值真的
    • allowInheriting(允许继承):类型布尔值,默认值真的
    • allowSizingOnChildren:类型布尔值,默认值
    • 允许垂直对齐:类型布尔值,默认值真的
    • 允许理由:类型布尔值,默认值真的
    • allow方向:类型布尔值,默认值真的
    • 允许自定义内容和宽尺寸:类型布尔值,默认值真的

此值仅适用于作为内部块容器的块。如果设置为真的布局类型为。对于其他布局类型,需要设置类型显式地在违约对象。

布局.默认

  • 类型:对象
  • 默认值:null

允许设置类型属性定义块的默认布局类型,以及该布局类型固有的任何属性的默认值。例如,对于弯曲布局,可以为设置默认值flexWrap(柔性包裹).

布局.允许切换

  • 类型:布尔值
  • 默认值:

显示允许在所有现有布局类型之间切换的切换器控件。

布局.允许编辑

  • 类型:布尔值
  • 默认值:真的

确定块侧栏中布局控件的显示。如果设置为false,布局控件将被隐藏。

layout.allowInheriting布局允许继承

  • 类型:布尔值
  • 默认值:真的

对于仅布局类型决定了“内部块使用内容宽度”切换的显示。

布局.allowSizingOnChildren

  • 类型:布尔值
  • 默认值:

对于弯曲仅布局类型决定了调整块的所有子块上的尺寸控制(调整/填充/固定)的显示。

布局允许垂直对齐

  • 类型:布尔值
  • 默认值:真的

对于弯曲仅布局类型决定了垂直对齐控件在块工具栏中的显示。

布局.允许对齐

  • 类型:布尔值
  • 默认值:真的

对于弯曲布局类型决定了块工具栏和块侧栏中对齐控件的显示。对于受约束的布局类型确定在块侧边栏中对正控件的显示。

布局.允许方向

  • 类型:布尔值
  • 默认值:真的

对于弯曲仅布局类型决定块工具栏中方向控件的显示。

布局允许自定义内容和宽尺寸

  • 类型:布尔值
  • 默认值:真的

对于受约束的仅布局类型决定了块侧边栏中自定义内容和宽尺寸控件的显示。

  • 类型:布尔值
  • 默认值:真的

块可能想要禁用切换锁定状态的能力。默认情况下,用户可以从块“选项”下拉列表中锁定/解锁。要禁用此行为,请设置.

支架:{//删除对锁定UI的支持。锁定:假}

倍数

  • 类型:布尔值
  • 默认值:真的

非多个块只能插入到每个帖子中一次。例如,如果正在编辑的文章中已经存在内置的“More”块,则无法再次插入它。非多个块的图标将自动变暗(不可勾选),以防止出现多个实例。

支架:{//每个帖子只使用一次区块倍数:false}

位置

注:从WordPress 6.2开始。

  • 类型:对象
  • 默认值:null
  • 子属性:
    • 粘性的:类型布尔值,默认值

此值表示块支持一些与位置相关的CSS样式属性。当它这样做时,块编辑器将显示UI控件,供用户设置其值,如果主题声明支持.

请注意,粘滞位置控件当前仅适用于在文档根级别设置的块。将块设置为粘性的当用户滚动页面时,position会将块粘贴到最直接的父级。

支架:{位置:{sticky:true//启用选择sticky位置。}}

当块声明支持特定位置属性时,其属性定义将扩展为包括风格属性。

  • 风格:的属性对象未指定默认值的类型。这是在以下情况下添加的粘性的声明支持。它存储用户设置的自定义值。例如:
属性:{样式:{位置:{类型:“粘性”,顶部:“0px”}}}

重命名

注:从WordPress 6.5开始。

  • 类型:布尔值
  • 默认值:真的

默认情况下,用户可以从块“选项”下拉列表或“高级”面板重命名块。要禁用此行为,请将重命名设置为false。

支架:{//不允许在编辑器中重命名块。重命名:false,}

可重复使用的

  • 类型:布尔值
  • 默认值:真的

块可能希望禁用转换为可重用块的功能。默认情况下,所有块都可以转换为可重用块。如果supports reusible设置为false,则不会显示将块转换为可重用块的选项。

支架:{//不允许将块转换为可重用块。可重用:false,}

阴影

注:从WordPress 6.5开始。

  • 类型:布尔值
  • 默认值:

此属性添加块控件,允许用户为块设置方框阴影。默认情况下禁用阴影。

支架:{shadow:true//启用box-shadow选择器。}

阴影预设源于中定义的阴影预设主题.json.

当块声明支持阴影,属性定义扩展为包括风格属性:

  • 风格:的属性对象未指定默认值的类型。

    选择阴影后,颜色值存储在样式阴影.

    块可以通过使用默认值指定自己的属性来应用默认阴影。例如:

    属性:{样式:{type:'对象',默认值:{shadow:“var:preset | shadow | deep”}}}

间距

  • 类型:对象
  • 默认值:null
  • 子属性:
    • 边缘:类型布尔值阵列,默认值
    • 衬垫:类型布尔值阵列,默认值
    • 块间隙:类型布尔值阵列,默认值

此值表示块支持一些与间距相关的CSS样式属性。当它这样做时,块编辑器将显示UI控件,供用户设置其值,如果主题声明支持.

支架:{间距:{margin:true,//启用margin UI控件。padding:true,//启用填充UI控件。blockGap:true,//为同时使用“布局”的块启用块间距UI控制。}}

当块声明支持特定间距特性时,其属性定义将扩展为包括风格属性。

  • 风格:的属性对象未指定默认值的类型。这是在以下情况下添加的边缘衬垫声明支持。它存储用户设置的自定义值。例如:
属性:{样式:{margin:'值',填充:{top:'值',}}}

间距属性可以定义可配置的允许边数组,包括“顶”、“右”、“底”、“左”。定义任意边时,只显示这些边的UI控件。

轴向侧定义为垂直的水平的术语,并为每个轴对显示单个UI控件(例如,垂直的控制顶侧和底侧)。间距属性可以支持任意单个边轴向侧,但不能两者兼而有之。

注:块间隙接受垂直的水平的轴向侧,用于调整间隙列和行值。块间隙不支持任意边。

支架:{间距:{margin:['top','bottom'],//为任意边启用边距。padding:true,//为所有边启用padding。blockGap:['水平','垂直'],//启用轴向(列/行)块间距控制}}

印刷术

  • 类型:对象
  • 默认值:无效的
  • 子属性:
    • 字体大小:类型布尔值,默认值
    • 线条高度:类型布尔值,默认值
    • text对齐:类型布尔值阵列,默认值

此对象的存在表示块支持某些与排版相关的属性。当它这样做时,块编辑器将显示一个排版UI,允许用户控制其值。

支持:{版式:{//启用字体大小的支持和UI控件。fontSize:true,//启用线高支持和UI控制。lineHeight:真,//为文本对齐启用支持和UI控件。text对齐:true,},}

字体.fontSize

  • 类型:布尔值
  • 默认值:

此值表示块支持字体大小的CSS样式属性。当它这样做时,块编辑器将显示一个UI控件,供用户设置其值。

此控件中显示的值是主题通过编辑字体大小 主题支持,如果未提供,则为默认值。

支架:{版式:{//启用字体大小的支持和UI控件。fontSize:true,},}

当块声明支持字体大小,属性定义扩展为包括两个新属性:字体大小风格:

  • 字体大小:的属性一串未指定默认值的类型。它存储用户选择的任何预设值。块可以通过指定自己的fontSize应用默认fontSize字体大小属性设置为默认值。例如:
属性:{字体大小:{type:'字符串',默认值:“some-value”,}}
  • 风格:的属性对象未指定默认值的类型。它存储用户设置的自定义值,并与其他块支持(如颜色)共享。块可以通过指定自己的样式来应用默认样式风格属性设置为默认值。例如:
属性:{样式:{type:'对象',默认值:{版式:{fontSize:'值'}}}}

排版.line高度

  • 类型:布尔值
  • 默认值:

此值表示块支持行高CSS样式属性。当它这样做时,块编辑器将显示一个UI控件,供用户设置其值,如果主题声明支持.

支架:{版式:{//启用线高支持和UI控制。lineHeight:真,},}

当块声明支持线条高度,属性定义扩展为包含新属性风格属于对象未指定默认值的类型。它存储用户设置的自定义值。块可以通过指定自己的样式来应用默认样式风格属性设置为默认值。例如:

属性:{样式:{type:'对象',默认值:{排版:{lineHeight:'值'}}}}

typegraphy.text对齐

注:从WordPress 6.6开始。

  • 类型:布尔值阵列
  • 默认值:

此属性添加块工具栏控件,这些控件允许更改块的文本对齐方式。

支架:{版式:{//声明支持块的文本对齐。//这增加了对所有选项的支持://左,中,右。text对齐:true}}
支架:{版式:{//声明对特定文本对齐选项的支持。text对齐:['左','右']}}

当块声明支持text对齐,属性定义扩展为包含新属性风格属于对象未指定默认值的类型。它存储用户设置的自定义值。块可以通过指定自己的样式来应用默认样式风格属性设置为默认值。例如:

属性:{样式:{类型:“对象”,默认值:{版式:{textAlign:“值”}}}}

分裂

设置为时真的,输入将块拆分为两个块。请注意
仅适用于简单的文本块,如带有
单一的超文本字段。中的RichText编辑功能必须有一个
标识符属性匹配文本的属性键,以便更新
选择正确,我们知道在哪里拆分。