编辑器界面数据

命名空间：core/edit-post。

选择器

areMetaBoxesInitialized

返回元框是否已初始化。

参数

state Object: 全局应用状态。

返回值

boolean: 元框是否已初始化。

getActiveGeneralSidebarName

返回当前活动的通用侧边栏名称，如果没有活动的通用侧边栏则返回 null。活动的通用侧边栏是一个用于标识编辑器或插件侧边栏的唯一名称。

示例：

edit-post/document
my-plugin/insert-image-sidebar

参数

state Object: 全局应用状态。

返回值

?string: 活动的通用侧边栏名称。

getActiveMetaBoxLocations

返回一个包含活动元框位置的数组。

参数

state Object: 文章编辑器状态。

返回值

string[]: 活动元框位置。

getAllMetaBoxes

返回所有可用元框的列表。

参数

state Object: 全局应用状态。

返回值

Array: 元框列表。

getEditedPostTemplate

获取当前编辑文章的模板。

返回值

?Object: 文章模板。

getEditorMode

返回当前的编辑模式。

参数

state Object: 全局应用状态。

返回值

string: 编辑模式。

getHiddenBlockTypes

返回一个包含所有隐藏区块的数组。

返回值

Array: 隐藏区块类型的列表

getMetaBoxesPerLocation

返回指定位置所有可用元框的列表。

参数

state Object: 全局应用状态。
location string: 要测试的元框位置。

返回值

?Array: 元框列表。

getPreference

参数

state Object: 全局应用状态。
preferenceKey string: 偏好设置键。
defaultValue *: 默认值。

返回值

*: 偏好设置值。

getPreferences

返回偏好设置（这些偏好设置会在本地持久化保存）。

参数

state Object: 全局应用状态。

返回值

Object: 偏好设置对象。

hasMetaBoxes

如果文章正在使用 Meta Boxes，则返回 true。

参数

state Object: 全局应用状态。

返回值

boolean: 是否存在元框。

isEditingTemplate

如果模板编辑模式已启用，则返回 true。

isEditorPanelEnabled

如果给定的面板已启用，则返回 true，否则返回 false。面板默认是启用的。

参数

state Object: 全局应用程序状态。
panelName string: 标识面板的字符串。

返回值

boolean: 面板是否已启用。

isEditorPanelOpened

如果给定面板已打开则返回 true，否则返回 false。面板默认处于关闭状态。

参数

state Object: 全局应用程序状态。
panelName string: 用于标识面板的字符串。

返回值

boolean: 面板是否处于打开状态。

isEditorPanelRemoved

如果给定的面板已被编程方式移除，则返回 true，否则返回 false。默认情况下，所有面板均未被移除。

参数

state Object: 全局应用程序状态。
panelName string: 标识面板的字符串。

返回值

boolean: 面板是否已被移除。

isEditorSidebarOpened

如果编辑器侧边栏已打开，则返回 true。

参数

state Object: 全局应用状态

boolean: 编辑器侧边栏是否已打开。

isFeatureActive

返回给定功能是否已启用。

参数

state Object: 全局应用状态。
feature string: 功能标识符。

boolean: 是否激活。

isInserterOpened

如果插入器已打开，则返回 true。

参数

state Object: 全局应用程序状态。

返回值

boolean: 插入器是否已打开。

isListViewOpened

如果列表视图已打开，则返回 true。

参数

state Object: 全局应用程序状态。

boolean: 列表视图是否已打开。

isMetaBoxLocationActive

如果给定位置存在活动的元框，则返回 true，否则返回 false。

参数

state Object: 文章编辑器状态。
location string: 要测试的元框位置。

boolean: 元框位置是否处于活动状态。

isMetaBoxLocationVisible

如果元框位置处于活动状态且可见，则返回 true

参数

state Object: 文章编辑器状态。
location string: 要测试的元框位置。

返回值

boolean: 元框位置是否处于活动状态且可见。

isModalActive

如果模态框处于活动状态则返回 true，否则返回 false。

参数

state Object: 全局应用程序状态。
modalName string: 唯一标识模态框的字符串。

返回值

boolean: 模态框是否处于活动状态。

isPluginItemPinned

如果插件项已固定到标题栏，则返回 true。未设置值时，默认值为 true。

参数

state Object: 全局应用程序状态。
pluginName string: 插件项名称。

返回值

boolean: 插件项是否已固定。

isPluginSidebarOpened

如果插件侧边栏已打开，则返回 true。

参数

state Object: 全局应用程序状态。

返回值

boolean: 插件侧边栏是否已打开。

isPublishSidebarOpened

如果发布侧边栏已打开，则返回 true。

参数

state Object: 全局应用程序状态

返回值

boolean: 发布侧边栏是否打开。

isSavingMetaBoxes

如果元框正在保存，则返回 true。

参数

state Object: 全局应用状态。

返回值

boolean: 元框是否正在保存。

操作

closeGeneralSidebar

返回一个操作对象，表示用户关闭了侧边栏。

closeModal

返回一个表示用户关闭模态框的操作对象。

返回值

Object: 操作对象。

closePublishSidebar

返回一个用于通知用户已关闭发布侧边栏的动作对象。

返回值

Object: 动作对象。

hideBlockTypes

更新指定的区块类型，使其隐藏。

参数

blockNames string[]: 要隐藏的区块类型名称。

initializeMetaBoxes

初始化 WordPress postboxes 脚本及保存元框的逻辑。

metaBoxUpdatesFailure

返回一个用于表示元框更新失败的动作对象。

返回值

Object: 动作对象。

metaBoxUpdatesSuccess

返回一个用于表示元框更新成功的操作对象。

返回值

Object: 操作对象。

openGeneralSidebar

返回一个用于表示用户打开了编辑器侧边栏的操作对象。

参数

name ?string: 要打开的侧边栏名称。

openModal

返回一个操作对象，用于发出用户打开模态框的信号。

参数

name string: 唯一标识模态框的字符串。

返回值

Object: 操作对象。

openPublishSidebar

返回一个动作对象，用于表示用户打开了发布侧边栏。

返回值

Object: 动作对象

removeEditorPanel

返回一个动作对象，用于从编辑器中移除一个面板。

参数

panelName string: 标识要移除的面板的字符串。

返回值

Object: 动作对象

requestMetaBoxUpdates

更新一个元信息框。

setAvailableMetaBoxesPerLocation

存储关于哪些元信息框在哪些位置可用的信息。

参数

metaBoxesPerLocation Object: 每个位置的元信息框。

setIsEditingTemplate

返回用于切换到模板编辑模式的操作对象。

setIsInserterOpened

返回用于打开/关闭插入器的操作对象。

参数

value boolean|Object: 插入器应打开（true）还是关闭（false）。

setIsListViewOpened

返回一个用于打开/关闭列表视图的操作对象。

参数

isOpen boolean: 一个布尔值，表示是否应打开或关闭列表视图。

showBlockTypes

更新指定区块类型为可见状态。

参数

blockNames string[]: 要显示的区块类型名称。

switchEditorMode

触发用于切换编辑器模式的操作。

参数

mode string: 编辑器模式。

toggleDistractionFree

用于切换无干扰模式的操作。无干扰模式下不应存在侧边栏，因为所设置的 z-index 值会导致侧边栏无法关闭。

toggleEditorPanelEnabled

返回一个用于启用或禁用编辑器中某个面板的操作对象。

参数

panelName string: 标识要启用或禁用的面板的字符串。

返回值

Object: 操作对象。

toggleEditorPanelOpened

打开一个关闭的面板，或关闭一个打开的面板。

参数

panelName string: 标识要打开或关闭的面板的字符串。

toggleFeature

触发用于切换功能标志的操作。

参数

feature string: 功能名称。

toggleFullscreenMode

切换全屏模式视图选项的操作。

togglePinnedPluginItem

触发用于切换插件名称标志的操作对象。

参数

pluginName string: 插件名称。

togglePublishSidebar

返回一个动作对象，用于表示用户切换了发布侧边栏。

返回值

Object: 动作对象

updatePreferredStyleVariations

返回一个动作对象，用于表示在创建区块时应自动应用某个样式。

这篇文档对你有帮助吗？