块编辑器数据-块编辑器手册|开发人员。WordPress.org网站

命名空间：核心/块编辑器.

选择器

内部块受控

检查给定块是否有受控的内部块。

参数

状态 对象：全局应用程序状态。
客户端ID 一串：要检查的块。

退换商品

布尔值：如果块已控制内部块，则为True。

canEditBlock

确定是否允许编辑给定块。

参数

状态 对象：编辑器状态。
客户端ID 一串：块客户端Id。

退换商品

布尔值：是否允许编辑给定块。

可以插入块

确定是否允许将给定块插入到块列表中。

参数

状态 对象：编辑器状态。
客户端ID 一串：要插入的块客户端ID。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

布尔值：是否允许插入给定的块。

can插入块类型

确定是否允许将给定的块类型插入到块列表中。

参数

状态 对象：编辑器状态。
块名称 一串：块类型的名称，例如“核心/段落”。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

布尔值：是否允许插入给定的块类型。

canLock块类型

确定用户是否可以锁定/解锁给定的块类型。

参数

状态 对象：编辑器状态。
名称或类型 （字符串|对象）：块名称或类型对象。

退换商品

布尔值：给定块类型是否可以锁定/解锁。

can移动块

确定是否允许移动给定块。

参数

状态 对象：编辑器状态。
客户端ID 一串：块客户端Id。

退换商品

布尔值：是否允许移动给定块。

can移动块

确定是否允许移动给定的块。

参数

状态 对象：编辑器状态。
客户端ID 一串：要移动的块客户端ID。

退换商品

布尔值：是否允许移动给定的块。

可以删除块

确定是否允许删除给定块。

参数

状态 对象：编辑器状态。
客户端ID 一串：块客户端Id。

退换商品

布尔值：是否允许删除给定块。

可以删除块

确定是否允许删除给定的块。

参数

状态 对象：编辑器状态。
客户端ID 一串：要删除的块客户端ID。

退换商品

布尔值：是否允许删除给定的块。

did自动更改

如果最后一次更改是自动更改，则返回true，否则返回false。

参数

状态 对象：全局应用程序状态。

退换商品

布尔值：上次更改是否为自动更改。

获取相邻块客户端ID

返回给定引用startClientId和修饰符方向性处相邻块的客户端ID。将startClientId默认设置为所选块，并将方向设置为下一个块。如果没有相邻块，则返回null。

参数

状态 对象：编辑器状态。
启动客户端Id ?一串：要从中搜索的块的可选客户端ID。
修改器 ?数：方向性倍增（下一个为1，上一个为-1）。

退换商品

?一串：返回块的客户端ID，如果不存在，则返回null。

获取允许的块

返回内部块子级允许的插入器块的列表。

参数

状态 对象：编辑器状态。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

阵列？：允许的块类型列表。

getBlock（获取块）

返回给定客户端ID的块。这是块的解析副本，包含块名称,客户端ID、和当前属性状态。这不是块的注册设置，必须从块模块注册存储中检索。

getBlock递归其内部块，直到检索到其所有子块。请注意，getBlock不会返回内部块控制器的子内部块。这是因为内部块控制器将自身与自己的实体同步，因此不应包含在不同实体的块中。例如，假设你打电话给获取块（TP）获取模板部件的块。如果另一个模板部件是TP的子部件，那么嵌套模板部件的子块将不会返回。这样，模板块本身被视为父块的一部分，但子块不是。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

对象：已分析的块对象。

获取块属性

根据给定的客户端ID返回块的属性，如果不存在具有客户端ID的块，则返回null。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

目标？：块属性。

获取块计数

返回文章中当前存在的块数。

参数

状态 对象：编辑器状态。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

数：立柱中的块数。

获取块编辑模式

返回给定块的块编辑模式。

该模式可以是三个选项之一：

“已禁用”：防止完全编辑块，即无法选择块。
'仅限内容'：隐藏所有非内容UI，例如工具栏中的辅助控件、块移动器、块设置。
“默认”：允许按正常方式编辑块。

块可以使用使用块编辑模式挂钩。

该模式由块的所有内部块继承，除非它们有自己的模式。

模板锁也可以设置模式。如果模板锁是'contentOnly'，块的模式被覆盖为'contentOnly'如果块具有content-role属性，或“已禁用”否则。

相关的

使用块编辑模式

参数

状态 对象：全局应用程序状态。
客户端ID 一串：块客户端ID，或''用于根容器。

退换商品

区块编辑模式：块编辑模式。什么之中的一个“已禁用”,'contentOnly'，或“默认”.

获取块层次根客户端Id

给定块客户机ID，返回嵌套块的层次结构的根，返回根级块的块本身。

参数

状态 对象：编辑器状态。
客户端ID 一串：从中查找根客户端ID的块。

退换商品

一串：根客户端ID

获取块索引

返回与指定客户端ID对应的块在块顺序中出现的索引，或-1如果块不存在。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

数：按顺序存在块的索引。

获取块插入点

返回插入提示的位置。默认为最后一个索引。

参数

状态 对象：编辑器状态。

退换商品

对象：插入点对象root客户端ID,指数.

获取块列表设置

返回块的“块列表”设置（如果存在）。

参数

状态 对象：编辑器状态。
客户端ID ?一串：阻止客户端ID。

退换商品

?对象：块的块设置（如果设置）。

获取块模式

返回块的编辑模式，如果未明确指定，则默认为“可视”。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

对象：块编辑模式。

获取块名称

根据给定的客户端ID返回块的名称，如果不存在具有客户端ID的块，则返回null。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

一串：块名称。

按客户端ID获取块名称

给定块客户端ID数组，返回相应的块名称数组。

参数

状态 对象：编辑器状态。
客户端ID 字符串[]：要返回块名称的客户端ID。

退换商品

字符串[]：块名称。

获取阻止订单

返回一个数组，其中包含编辑器中所有块客户端ID，并按其显示顺序排列。（可选）接受应为其返回订单的阻止列表的根客户端ID，默认为顶级阻止订单。

参数

状态 对象：编辑器状态。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

阵列：编辑器块的有序客户端ID。

获取阻止家长

给定块客户端ID，从上到下返回其所有父级的列表。

参数

状态 对象：编辑器状态。
客户端ID 一串：从中查找根客户端ID的块。
提升 布尔值：将结果从下到上排序（true）或从上到下排序（false）。

退换商品

阵列：父块的ClientID。

按块名称获取块家长

给定块客户机ID和块名称，从上到下返回按给定名称筛选的所有父级的列表。例如，如果传递“core/group”作为blockName，它将只返回作为组块的父级。如果通过[“核心/组”，“核心/覆盖”]，作为blockName，它将返回作为组块的父块和作为覆盖块的父块。

参数

状态 对象：编辑器状态。
客户端ID 一串：从中查找根客户端ID的块。
块名称 string|string[]：要筛选的块名称。
提升 布尔值：按自下而上（true）或自上而下（false）的顺序排列结果。

退换商品

阵列：父块的ClientID。

获取块根客户端ID

给定块客户机ID，返回嵌套块的根块、顶层块的空字符串，如果块不存在，则返回null。

参数

状态 对象：编辑器状态。
客户端ID 一串：从中查找根客户端ID的块。

退换商品

?一串：根客户端ID（如果存在）

获取块

返回当前文章的所有块对象，这些对象以数组的形式进行编辑，并按其在文章中的显示顺序排列。请注意，这将排除嵌套内部块控制器的子块。

参数

状态 对象：编辑器状态。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

对象[]：立柱块。

按客户端ID获取块

给定块客户端ID数组，返回相应的块对象数组。

参数

状态 对象：编辑器状态。
客户端ID 字符串[]：要为其返回块的客户端ID。

退换商品

WP块[]：块对象。

按名称获取块

返回与blockName匹配的所有块。结果包括嵌套块。

参数

状态 对象：全局应用程序状态。
块名称 字符串[]：要为其返回clientId的块名称。

退换商品

阵列：名称等于blockName的块的clientId数组。

获取块选择结束

返回当前块选择结束。该值可以为空，并且可以表示单个块选择或多选择结束。如果选择的开始和结束匹配，则选择是单数。

参数

状态 对象：全局应用程序状态。

退换商品

?一串：块选择结束的客户端ID。

获取块选择开始

返回当前块选择的起点。该值可以为空，并且可以表示单个块选择或多选择开始。如果选择的开始和结束匹配，则选择是单数。

参数

状态 对象：全局应用程序状态。

退换商品

?一串：块选择开始的客户端ID。

获取块转换项目

确定出现在可用块变换列表中的项目。

每个项目对象都包含在变换列表中显示菜单项和处理其选择所必需的内容。

“频率”属性是一个启发式(https://en.wikipedia.org/wiki/Frecency网站)它结合了块使用频率和最近度。

返回的项目按“频率”降序排列。

参数

状态 对象：编辑器状态。
阻碍 对象|对象[]：块对象或数组对象。
根客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

WPEditorTransformItem[]：插入器中出现的项目。

类型定义

WP编辑器转换项 对象

属性

身份证件 一串：项目的唯一标识符。
名称 一串：要创建的块的类型。
标题 一串：项目的标题，如插入器中所示。
偶像 一串：项目的仪表板图标，如插入器中所示。
已禁用 布尔值：是否应阻止用户插入此项目。
频率 数：结合频率和近因的启发式。

getClientIdsOfDescendants

返回一个数组，其中包含给定块的所有后代的客户端ID。返回的id首先按给定的id的顺序排序，然后按它们在编辑器中的显示顺序排序。

参数

状态 对象：全局应用程序状态。
根ID string|string[]：要为其返回子代块的客户端ID。

退换商品

阵列：后代的客户端ID。

带有子体的getClientIds

返回一个数组，其中包含顶级块的clientId及其任意深度的后代（对于嵌套块）。Id的返回顺序与它们在编辑器中显示的顺序相同。

参数

状态 对象：全局应用程序状态。

退换商品

阵列：顶级块和子代块的ID。

获取直接插入块

返回要由块追加器直接插入的块。

参数

状态 对象：编辑器状态。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

WPDirectInsertBlock |未定义：要直接插入的块类型。

类型定义

WPDirectInsert块 对象

属性

名称 一串：块的类型。
属性 ?对象：要传递给新创建块的属性。
要复制的属性 ?数组<string>：插入时要从相邻块复制的属性。

获取DraggedBlockClientId

返回直接拖动的任何块的客户端ID。

这不包括被拖动父对象的子对象。

参数

状态 对象：全局应用程序状态。

退换商品

字符串[]：拖动块客户端ID的数组。

获取第一个多选择块客户端ID

返回多选择集中第一个块的客户端ID，如果没有多选择，则返回null。

参数

状态 对象：编辑器状态。

退换商品

?一串：多选择集中的第一个块客户端ID。

获取全局块计数

返回块的总数，或文章中具有特定名称的块的总数。返回的数字包括嵌套块。

参数

状态 对象：全局应用程序状态。
块名称 ?一串：可选块名，如果指定，则只计算该类型的块。

退换商品

数：文章中的块数，或名称等于blockName的块数。

获取悬停块客户端ID

返回当前悬停的块。

参数

状态 对象：全局应用程序状态。

退换商品

对象：悬停块的客户端Id。

获取插入器项

确定插入器中出现的项。包括静态项（例如常规块类型）和动态项（例如可重用块）。

每个项目对象都包含在插入器中显示按钮和处理其选择所必需的内容。

“频率”属性是一个启发式(https://en.wikipedia.org/wiki/Frency)它结合了块使用频率和最近度。

返回的项目按其“效用”和“频率”降序排列。

参数

状态 对象：编辑器状态。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

WP编辑器插入项[]：插入器中出现的项目。

类型定义

WP编辑器插入器项 对象

属性

身份证件 一串：项目的唯一标识符。
名称 一串：要创建的块的类型。
initialAttributes（初始属性） 对象：要传递给新创建块的属性。
标题 一串：项目的标题，如插入器中所示。
偶像 一串：项目的仪表板图标，如插入器中所示。
类别 一串：与项目关联的块类别。
关键字 字符串[]：可以搜索以查找此项目的关键字。
已禁用 布尔值：是否应阻止用户插入此项目。
频率 数：结合频率和近因的启发式。

获取最后一个多选块客户端Id

返回多选择集中最后一个块的客户端ID，如果没有多选择，则返回null。

参数

状态 对象：编辑器状态。

退换商品

?一串：多选择集中的最后一个块客户端ID。

使用所选块获取最低通用祖先

给定块客户机ID，返回具有所选客户机ID的最低公共祖先。

参数

状态 对象：编辑器状态。
客户端ID 一串：从中查找公共祖先客户端ID的块。

退换商品

一串：公共祖先客户端ID或未定义

获取多选择块客户端ID

返回块客户端ID的当前多选择集，如果没有多选择，则返回空数组。

参数

状态 对象：编辑器状态。

退换商品

阵列：多选块客户端ID。

获取多选块

返回当前块的多选择集，如果没有多选择，则返回空数组。

参数

状态 对象：编辑器状态。

退换商品

阵列：多选块对象。

获取多选块结束客户端ID

返回结束多重选择集的块的客户端ID，如果没有多重选择，则返回null。

这不一定是所选内容中的最后一个客户端ID。

相关的

获取最后一个多选块客户端Id

参数

状态 对象：编辑器状态。

退换商品

?一串：结束多重选择的块的客户端ID。

获取多选块启动客户端ID

返回多选择集开始的块的客户端ID，如果没有多选择，则返回null。

这不一定是所选内容中的第一个客户端ID。

相关的

获取第一个多选择块客户端ID

参数

状态 对象：编辑器状态。

退换商品

?一串：开始多重选择的块的客户端ID。

获取下一块客户端ID

从给定的引用开始ID返回下一个块的客户端ID。默认开始为所选块。如果没有下一个块，则返回null。

参数

状态 对象：编辑器状态。
启动客户端ID ?一串：要从中搜索的块的可选客户端ID。

退换商品

?一串：相邻块的客户端ID，如果不存在，则为空。

按块类型获取模式

根据模式的声明返回模式列表块类型和块的名称。模式可以使用块类型在工作流中集成，如在占位符状态（插入期间）或块转换中建议适当的模式。

参数

状态 对象：编辑器状态。
块名称 string|string[]：块的名称或块名称数组以查找匹配模式。
root客户端ID ?一串：可选的目标根客户端ID。

退换商品

阵列：基于声明的匹配块模式列表块类型和块名称。

获取上一个块客户端ID

从给定的参考开始ID返回上一个块的客户端ID。默认开始为所选块。如果没有前一个块，则返回null。

参数

状态 对象：编辑器状态。
启动客户端Id ?一串：要从中搜索的块的可选客户端ID。

退换商品

?一串：相邻块的客户端ID，如果不存在，则为空。

获取选定块

返回当前选定的块，如果没有选定的块则返回null。

参数

状态 对象：全局应用程序状态。

退换商品

?对象：所选块。

获取选定块客户端ID

返回当前选定的块客户端ID，如果没有选定的块，则返回null。

参数

状态 对象：编辑器状态。

退换商品

?一串：选定的块客户端ID。

获取所选块客户端ID

返回块客户端ID的当前选择集（多选或单选）。

参数

状态 对象：编辑器状态。

退换商品

阵列：多选块客户端ID。

获取所选块计数

返回当前在帖子中选择的块数。

参数

状态 对象：全局应用程序状态。

退换商品

数：文章中选择的块数。

获取所选块初始插入位置

返回选定块的初始插入符号位置。此位置用于在选定块更改时正确定位插入符号。如果当前块不是RichText，则初始位置设置为0表示“焦点块”

参数

状态 对象：全局应用程序状态。

退换商品

0|-1|null：初始位置。

获取选择结束

返回当前选择的结束块客户端ID、属性键和文本偏移量。

参数

状态 对象：块编辑器状态。

退换商品

WP块选择：选择结束信息。

获取选择开始

返回当前选择开始块客户端ID、属性键和文本偏移量。

参数

状态 对象：块编辑器状态。

退换商品

WP块选择：选择开始信息。

获取设置

返回编辑器设置。

参数

状态 对象：编辑器状态。

退换商品

对象：编辑器设置对象。

获取模板

返回定义的块模板

参数

状态 布尔值:

退换商品

?阵列：块模板。

获取模板锁定

返回定义的块模板锁。可选地接受根块客户机ID作为上下文，否则默认为全局上下文。

参数

状态 对象：编辑器状态。
根客户端ID ?一串：可选块根客户端ID。

退换商品

字符串|假：块模板锁定

hasBlockMovingClientId

已弃用

返回是否启用块移动模式。

hasDraggedInner块

如果拖动块的内部块之一，则返回true。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。
深的 布尔值：进行深入检查。

退换商品

布尔值：块是否已拖动内部块

有InserterItems

确定插入器中是否有要显示的项。

参数

状态 对象：编辑器状态。
root客户端ID ?一串：阻止列表的可选根客户端ID。

退换商品

布尔值：插入器中出现的项目。

具有多重选择

如果进行了多次选择，则返回true，否则返回false。

参数

状态 对象：编辑器状态。

退换商品

布尔值：是否进行了多次选择。

已选择块

如果只有一个选定块，则返回true，否则返回false。

参数

状态 对象：编辑器状态。

退换商品

布尔值：是否选择单个块。

已选择内部块

如果选择块的内部块之一，则返回true。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。
深的 布尔值：执行深度检查。

退换商品

布尔值：块是否已选择内部块

isAncestorBeing已拖动

返回是否正在拖动块的父/祖先。

参数

状态 对象：全局应用程序状态。
客户端ID 一串：要检查的块的客户端id。

退换商品

布尔值：是否正在拖动块的祖先。

是AncestorMultiSelected

如果块的祖先是多选的，则返回true，否则返回false。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

布尔值：块的祖先是否在多选择集中。

被拖动的阻止

返回是否正在拖动块。

仅当直接拖动块时才返回true，如果块是被拖动父对象的子对象，则不返回true。请参见是祖先还是被拖拽用于子块。

参数

状态 对象：全局应用程序状态。
客户端ID 一串：要检查的块的客户端id。

退换商品

布尔值：是否正在拖动块。

is块高亮显示

如果当前高亮显示的块与块clientId匹配，则返回true。

参数

状态 对象：全局应用程序状态。
客户端ID 一串：要检查的块。

退换商品

布尔值：块当前是否高亮显示。

isBlock插入点可见

如果块插入点可见，则返回true。

参数

状态 对象：全局应用程序状态。

退换商品

?布尔值：插入点是否可见。

isBlock多选

如果客户端ID发生在块多重选择中，则返回true，否则返回false。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

布尔值：块是否在多选择集中。

已选择isBlock

如果当前选择了与指定客户机ID对应的块，并且不存在多重选择，则返回true，否则返回false。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

布尔值：是否选择了块，是否存在多重选择。

isBlock有效

返回块是否有效。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

布尔值：有效。

isBlockVisible（块可见）

指示块在画布上是否可见。

参数

状态 对象：全局应用程序状态。
客户端ID 对象：块的客户端Id。

退换商品

布尔值：如果块可见，则为True。

在选择中是块

如果与指定客户端ID对应的块当前已选定，但不是最后一个选定的块，则返回true。这里的“last”是指文档中的块序列，不多重选举的顺序，这就是为什么状态选择结束未使用。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

布尔值：是否选择块，而不是选择中的最后一个块。

是带格式文本的插入符号

已弃用

如果插入符号在格式化文本中，则返回true，否则返回false。

退换商品

布尔值：插入符号是否在格式化文本中。

is拖动块

如果用户拖动块，则返回true，否则返回false。

参数

状态 对象：全局应用程序状态。

退换商品

布尔值：用户是否正在拖动块。

是第一个多选块

如果存在多选择，并且与指定客户端ID对应的块是多选择集的第一个块，则返回true，否则返回false。

参数

状态 对象：编辑器状态。
客户端ID 一串：阻止客户端ID。

退换商品

布尔值：块在多次选择中是否为第一个。

可分组

指示提供的块（按客户端ID）是否可分组。我们需要至少有一个块，有一个分组块名称集，并且能够删除这些块。

参数

状态 对象：全局应用程序状态。
客户端ID 字符串[]：阻止客户端ID。如果未通过，将使用所选块的客户端ID。

退换商品

布尔值：如果块可分组，则为True。

上次块更改持续

如果最近的块更改被认为是持久的，则返回true，否则返回false。持久更改是由BlockEditorProvider通过其onChange（更改时）回调，除了onInput（输入）.

参数

状态 对象：块编辑器状态。

退换商品

布尔值：最近的块更改是否持久。

是多重选择

无论是否处于多选过程中。此标志仅在选择多重选择（通过鼠标移动）时为true，而在确定多重选择后为false。

相关的

具有多重选择

参数

状态 对象：全局应用程序状态。

退换商品

布尔值：多选为True，非多选为false。

isNavigationMode（导航模式）

返回导航模式是否已启用。

参数

状态 对象：编辑器状态。

退换商品

布尔值：是否启用导航模式。

已启用选择

如果启用或未启用多重选择，则返回的选择器。

参数

状态 对象：全局应用程序状态。

退换商品

布尔值：如果可以多选块，则为True；如果禁用了多选，则为false。

正在键入

如果用户正在键入，则返回true，否则返回false。

参数

状态 对象：全局应用程序状态。

退换商品

布尔值：用户是否正在键入。

不可分组

指示块是否可解组。如果块是具有内部块的单个分组块，则该块是不可分组的。如果块具有取消分组转换时，它也是不可分组的，无需作为默认分组块。此外，只有当块具有内部块并且可以删除时，才能将其解组。

参数

状态 对象：全局应用程序状态。
客户端ID 一串：块的客户端Id。如果未传递，将使用所选块的客户端id。

退换商品

布尔值：如果块不可组合，则为True。

有效模板

返回块是否与模板匹配。

参数

状态 布尔值:

退换商品

?布尔值：模板是否有效。

已插入块Just

指示是否刚插入了传递了clientId的块。

参数

状态 对象：全局应用程序状态。
客户端ID 对象：块的客户端Id。
来源 ?一串：块的可选插入源。

退换商品

布尔值：如果块与从指定源插入的最后一个块匹配，则为True。

行动

清除所选块

清除块选择的操作。

退换商品

对象：Action对象。

复制块

复制块列表的操作。

参数

客户端ID 字符串[]:
更新所选内容 布尔值:

输入格式化文本

已弃用

返回用于指示插入符号已输入格式化文本的操作对象。

退换商品

对象：Action对象。

现有格式文本

已弃用

返回用于指示用户插入符号已退出格式化文本的操作对象。

退换商品

对象：Action对象。

闪存块

用给定的客户端ID通过有节奏地突出显示它。

参数

客户端ID 一串：目标块客户端ID。

隐藏插入点

隐藏插入点的操作。

hoverBlock（悬浮块）

返回一个操作对象，该对象用于发出具有指定客户端ID的块已悬停的信号。

参数

客户端ID 一串：阻止客户端ID。

退换商品

对象：Action对象。

插入后块

在给定块后插入默认块的操作。

参数

客户端ID 一串:

在块之前插入

在给定块之前插入默认块的操作。

参数

客户端ID 一串:

插入块

插入单个块的操作，可选地在相应的根块列表的特定索引处。

只插入允许的块。对于不允许的块，或者如果块列表上的templateLock处于活动状态，则操作可能会以静默方式失败。

参数

块 对象：要插入的块对象。
指数 ?数：应插入块的索引。
root客户端ID ?一串：要插入的阻止列表的可选根客户端ID。
更新所选内容 ?布尔值：如果将更新真正的块选择。如果为false，块选择将不会更改。默认为true。
元 ?对象：要传递给操作对象的可选元值。

退换商品

对象：Action对象。

插入块

插入块数组的操作，可以选择在与根块列表相对应的特定索引处插入块数组。

只插入允许的块。对于不允许的块，或者如果块列表上的templateLock处于活动状态，则操作可能会以静默方式失败。

参数

阻碍 对象[]：要插入的块对象。
指数 ?数：应插入块的索引。
root客户端ID ?一串：要插入的阻止列表的可选根客户端ID。
更新所选内容 ?布尔值：如果将更新真正的块选择。如果为false，块选择将不会更改。默认为true。
initialPosition（初始位置） 0|-1|null：初始焦点位置。将其设置为空可防止聚焦插入的块。
元 ?对象：要传递给操作对象的可选元值。

退换商品

对象：Action对象。

插入默认块

将默认类型的新块添加到块列表中的操作。

参数

属性 ?对象：要指定的块的可选属性。
root客户端ID ?一串：要追加的阻止列表的可选根客户端ID。
指数 ?数：插入默认块的可选索引。

合并块

合并两个块的操作。

参数

第一块客户端ID 一串：要合并的第一个块的客户端ID。
第二块客户端ID 一串：要合并的第二个块的客户端ID。

移动阻止向下移动

未记录的声明。

将块移动到位置

将给定块移动到新位置的操作。

参数

客户端ID ?一串：块的客户端ID。
来自RootClientId ?一串：根客户端ID源。
到根客户端Id ?一串：根客户端ID目标。
指数 数：将块移动到的索引。

向上移动块

未记录的声明。

将块移动到位置

将给定块移动到新位置的操作。

参数

客户端ID ?一串：块的客户端ID。
来自RootClientId ?一串：根客户端ID源。
到根客户端Id ?一串：根客户端ID目标。
指数 数：将块移动到的索引。

多重选择

更改阻止多选的操作。

参数

开始 一串：多选的第一块。
结束 一串：多选的最后一块。
__实验初始位置 number |空：可选初始位置。传递为null以跳过编辑器画布中的焦点。

接收块

已弃用

返回用于发出已收到块的信号的操作对象。与resetBlocks不同，这些块应该附加到现有的已知集，而不是替换。

参数

阻碍 对象[]：块对象数组。

退换商品

对象：Action对象。

寄存器插入器媒体类别

注册新的插入器媒体类别。注册后，介质类别便可在插入器的介质选项卡中找到。

使用以下接口：

类型定义

插入器介质请求 对象：插入器介质请求接口。

属性

每个页面（_P） 数：每页要提取的项目数。
搜索 一串：用于筛选结果的搜索词。

类型定义

插入器介质项 对象：插入器媒体响应的接口。任何媒体资源都应该将其响应映射到此界面，以便创建核心WordPress媒体块（图像、视频、音频）。

属性

标题 一串：媒体项的标题。
网址`string：媒体项的源url。
预览URL [字符串]：要在媒体列表中显示的媒体项的预览源url。
身份证件 [编号]：媒体项的WordPress id。
源ID [number|string]：来自外部源的媒体项的id。
中高音 [字符串]：媒体项的替换文本。
标题 [字符串]：媒体项的标题。

用法

wp.data.dispatch（“核心/块编辑器”）.registerInserterMediaCategory（{名称：“openverse”，标签：{name:'Openverse'，search_items:'搜索Openverse'，},mediaType:'图像'，异步获取（查询={}）{常量defaultArgs={成熟：错误，excluded_source:'flickr，非专业人士，wikimedia'，许可证：'pdm，cc0'，};const finalQuery={…query，…defaultArgs}；//有时可能需要根据“InserterMediaRequest”映射受支持的请求参数。//接口。在本例中，`search`查询参数命名为`q`。常量映射FromInserterMedia请求={per_page:'页面大小'，搜索：'q'，};const url=新url（'https://api.openverse.org/v1/images网站/' );Object.entries（finalQuery）.forEach（（[key，value]）=>{const queryKey=mapFromInserterMedia请求[key]| | key；url.searchParams.set（queryKey，value）；} );const响应=等待window.fetch（url{标题：{“用户代理”：“WordPress/inserter-media-fetch”，},} );const jsonResponse=等待响应.json（）；const results=jsonResponse.results；return results.map（（result）=>（{…结果，//如果您的响应结果中包含稍后要访问的“id”属性，则应该//映射到`InserterMediaItem`的`sourceId`属性。如果您提供//报告URL获取器。//此外，您应该始终清除响应结果的“id”值，因为//它用于识别WordPress媒体项目。sourceId:结果id，id：未定义，标题：result.caption，预览Url:result.thumbnail，} ) );},getReportUrl:（{sourceId}）=>`https://wordpress.org/openverse/image/${sourceId}/report/`，isExternalResource:true，} );

参数

类别 插入器介质类别：要注册的插入器媒体类别。

类型定义

插入器媒体类别 对象：插入器媒体类别的接口。

属性

名称 一串：媒体类别的名称，在所有媒体类别中应该是唯一的。
标签 对象：媒体类别的标签。
标签名称 一串：媒体类别的常规名称。它用于插入器媒体项列表。
标签搜索项 [字符串]：用于搜索项目的标签。默认为“搜索帖子”/“搜索页面”。
媒体类型 （“图像”|“音频”|“视频”）：媒体类别的媒体类型。
取来 （InserterMedia请求）=>承诺：获取类别媒体项的函数。
获取报告URL [（InserterMediaItem）=>字符串]：如果媒体类别支持报告媒体项，则此函数应返回媒体项的报告url。它接受插入器介质项作为一个论点。
是外部资源 [布尔值]：如果媒体类别是外部资源，则应将其设置为true。这用于避免在用户