命名空间:core/edit-post。
选择器
areMetaBoxesInitialized
如果 Meta Boxes 已初始化,则返回 true。
参数
- state
Object:全局应用状态。
返回
boolean:Meta Boxes 是否已初始化。
getActiveGeneralSidebarName
返回当前活动的通用侧边栏名称,如果没有处于活动状态的通用侧边栏,则返回 null。活动的通用侧边栏是一个唯一名称,用于标识编辑器侧边栏或插件侧边栏。
示例:
edit-post/documentmy-plugin/insert-image-sidebar
参数
- state
Object:全局应用状态。
返回
?string:活动的通用侧边栏名称。
getActiveMetaBoxLocations
返回活动的 Meta Box 位置的数组。
参数
- state
Object:文章编辑器状态。
返回
string[]:活动的 Meta Box 位置。
getAllMetaBoxes
返回所有可用 Meta Boxes 的列表。
参数
- state
Object:全局应用状态。
返回
Array:Meta Boxes 列表。
getEditedPostTemplate
获取当前正在编辑的文章的模板。
返回
?Object:文章模板。
getEditorMode
返回当前编辑模式。
参数
- state
Object:全局应用状态。
返回
string:编辑模式。
getHiddenBlockTypes
返回被隐藏的区块数组。
返回
Array:隐藏区块类型的列表
getMetaBoxesPerLocation
返回给定位置的所有可用 Meta Boxes 的列表。
参数
- state
Object:全局应用状态。 - location
string:要测试的 Meta Box 位置。
返回
?Array:Meta Boxes 列表。
getPreference
参数
- state
Object:全局应用状态。 - preferenceKey
string:偏好设置键。 - defaultValue
*:默认值。
返回
*:偏好设置值。
getPreferences
返回偏好设置(这些偏好设置会持久保存在本地)。
参数
- state
Object:全局应用状态。
返回
Object:偏好设置对象。
hasMetaBoxes
如果文章正在使用 Meta Boxes,则返回 true
参数
- state
Object:全局应用状态
返回
boolean:是否存在 Meta Boxes。
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:功能的 slug。
返回
boolean:是否处于启用状态。
isInserterOpened
已弃用
如果插入器已打开,则返回 true。
参数
- state
Object:全局应用状态。
返回
boolean:插入器是否已打开。
isListViewOpened
如果列表视图已打开,则返回 true。
参数
- state
Object:全局应用状态。
返回
boolean:列表视图是否已打开。
isMetaBoxLocationActive
如果给定位置存在活动的 Meta Box,则返回 true,否则返回 false。
参数
- state
Object:文章编辑器状态。 - location
string:要测试的 Meta Box 位置。
返回
boolean:该 Meta Box 位置是否处于活动状态。
isMetaBoxLocationVisible
如果 Meta Box 位置处于活动且可见状态,则返回 true
参数
- state
Object:文章编辑器状态。 - location
string:要测试的 Meta Box 位置。
返回
boolean:该 Meta Box 位置是否处于活动且可见状态。
isModalActive
已弃用(自 WP 6.3 起),请改用
core/interfacestore 中同名的选择器。
如果模态框处于活动状态,则返回 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
如果 Meta Boxes 正在保存中,则返回 true。
参数
- state
Object:全局应用状态。
返回
boolean:Meta Boxes 是否正在保存中。
动作
closeGeneralSidebar
返回一个表示用户已关闭侧边栏的动作对象。
closeModal
已弃用(自 WP 6.3 起),请改用
core/interfacestore 中同名的动作。
返回一个表示用户已关闭模态框的动作对象。
返回
Object:动作对象。
closePublishSidebar
已弃用
返回一个用于表示用户已关闭发布侧边栏的动作对象。
返回
Object:动作对象。
hideBlockTypes
将提供的区块类型设置为隐藏。
参数
- blockNames
string[]:要隐藏的区块类型名称。
initializeMetaBoxes
初始化 WordPress postboxes 脚本以及保存 Meta Boxes 的逻辑。
metaBoxUpdatesFailure
返回一个用于表示 Meta Box 更新失败的动作对象。
返回
Object:动作对象。
metaBoxUpdatesSuccess
返回一个用于表示 Meta Box 更新成功的动作对象。
返回
Object:动作对象。
openGeneralSidebar
返回一个动作对象,用于表示用户打开了编辑器侧边栏。
参数
- name
?string:要打开的侧边栏名称。
openModal
已弃用:自 WP 6.3 起,请改用
core/interfacestore 中的同名动作。
返回一个动作对象,用于表示用户打开了一个模态框。
参数
- name
string:一个唯一标识该模态框的字符串。
返回
Object:动作对象。
openPublishSidebar
已弃用
返回一个动作对象,用于表示用户打开了发布侧边栏。
返回
Object:动作对象
removeEditorPanel
已弃用
返回一个用于从编辑器中移除面板的动作对象。
参数
- panelName
string:一个标识要移除的面板的字符串。
返回
Object:动作对象。
requestMetaBoxUpdates
更新一个 metabox。
setAvailableMetaBoxesPerLocation
存储关于哪些 Meta box 在哪些位置可用的信息。
参数
- metaBoxesPerLocation
Object:每个位置的 Meta box。
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
已弃用
返回一个动作对象,用于表示在创建区块时应自动应用某个样式。