9.6 KiB
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
已弃用
返回用于通知在创建区块时应自动应用样式的动作对象。
编辑器界面数据
命名空间：core/edit-post
选择器
areMetaBoxesInitialized
判断元框是否已完成初始化。
参数
- state
Object: 全局应用状态
返回值
boolean: 元框是否已初始化
getActiveGeneralSidebarName
返回当前活动的通用侧边栏名称，若无活动侧边栏则返回null。活动通用侧边栏是用于识别编辑器或插件侧边栏的唯一名称。
示例：
edit-post/documentmy-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
判断文章是否正在使用元框。
参数
- state
Object: 全局应用状态
返回值
boolean: 是否存在元框
isEditingTemplate
已弃用
判断是否启用了模板编辑模式。
isEditorPanelEnabled
已弃用
判断指定面板是否启用，面板默认处于启用状态。
参数
- state
Object: 全局应用状态 - panelName
string: 面板标识字符串
返回值
boolean: 面板是否启用
isEditorPanelOpened
已弃用
判断指定面板是否打开，面板默认处于关闭状态。
参数
- state
Object: 全局应用状态 - panelName
string: 面板标识字符串
返回值
boolean: 面板是否打开
isEditorPanelRemoved
已弃用
判断指定面板是否已被程序化移除，所有面板默认不会被移除。
参数
- state
Object: 全局应用状态 - panelName
string: 面板标识字符串
返回值
boolean: 面板是否已被移除
isEditorSidebarOpened
判断编辑器侧边栏是否打开。
参数
- state
Object: 全局应用状态
返回值
boolean: 编辑器侧边栏是否打开
isFeatureActive
判断指定功能是否启用。
参数
- state
Object: 全局应用状态 - feature
string: 功能标识符
返回值
boolean: 是否处于活动状态
isInserterOpened
已弃用
返回插入器是否处于打开状态。
参数
- state
Object: 全局应用状态。
返回值
boolean: 插入器是否已打开。
isListViewOpened
返回列表视图是否处于打开状态。
参数
- state
Object: 全局应用状态。
返回值
boolean: 列表视图是否已打开。
isMetaBoxLocationActive
如果给定位置存在活动的元框则返回 true，否则返回 false。
参数
- state
Object: 文章编辑器状态。 - location
string: 要测试的元框位置。
返回值
boolean: 元框位置是否处于活动状态。
isMetaBoxLocationVisible
如果元框位置处于活动状态且可见则返回 true。
参数
- state
Object: 文章编辑器状态。 - location
string: 要测试的元框位置。
返回值
boolean: 元框位置是否处于活动且可见状态。
isModalActive
已弃用（自 WP 6.3 起，请改用
core/interface存储中间名选择器）
如果模态框处于活动状态则返回 true，否则返回 false。
参数
- state
Object: 全局应用状态。 - modalName
string: 唯一标识模态框的字符串。
返回值
boolean: 模态框是否处于活动状态。
isPluginItemPinned
如果插件项已固定到标题区域则返回 true。未设置值时默认返回 true。
参数
- state
Object: 全局应用状态。 - pluginName
string: 插件项名称。
返回值
boolean: 插件项是否已固定。
isPluginSidebarOpened
返回插件侧边栏是否处于打开状态。
参数
- state
Object: 全局应用状态。
返回值
boolean: 插件侧边栏是否已打开。
isPublishSidebarOpened
已弃用
返回发布侧边栏是否处于打开状态。
参数
- state
Object: 全局应用状态。
返回值
boolean: 发布侧边栏是否已打开。
isSavingMetaBoxes
如果元框正在保存则返回 true。
参数
- state
Object: 全局应用状态。
返回值
boolean: 元框是否正在保存。
操作
closeGeneralSidebar
返回表示用户关闭侧边栏的操作对象。
closeModal
已弃用（自 WP 6.3 起，请改用
core/interface存储中间名操作）
返回表示用户关闭模态框的操作对象。
返回值
Object: 操作对象。
closePublishSidebar
已弃用
返回表示用户关闭发布侧边栏的操作对象。
返回值
Object: 操作对象。
hideBlockTypes
将指定区块类型设置为隐藏状态。
参数
- blockNames
string[]: 需要隐藏的区块类型名称。
initializeMetaBoxes
初始化 WordPress postboxes 脚本及元框保存逻辑。
metaBoxUpdatesFailure
返回表示元框更新失败的操作对象。
返回值
Object: 操作对象。
metaBoxUpdatesSuccess
返回表示元框更新成功的操作对象。
返回值
Object: 操作对象。
openGeneralSidebar
返回表示用户打开编辑器侧边栏的操作对象。
参数
- name
?string: 要打开的侧边栏名称。
openModal
已弃用（自 WP 6.3 起，请改用
core/interface存储中间名操作）
返回表示用户打开模态框的操作对象。
参数
- name
string: 唯一标识模态框的字符串。
返回值
Object: 操作对象。