gutenbergdocs/reference-guides/data/data-core-edit-site.md

448 lines
6.9 KiB
Markdown
Raw Normal View History

2025-10-21 17:33:45 +00:00
# 编辑站点
命名空间:`core/edit-site`
## 选择器
<!-- START TOKEN(Autogenerated selectors|../../../packages/edit-site/src/store/selectors.js) -->
### getCanUserCreateMedia
返回当前用户是否可创建媒体。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `Object`: 当前用户是否可创建媒体。
### getCurrentTemplateNavigationPanelSubMenu
> **已弃用**
### getCurrentTemplateTemplateParts
> **已弃用**
返回当前编辑模板的模板部件及其区块。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `Array`: 包含模板部件及其区块的数组。
### getEditedPostContext
> **已弃用**
返回已编辑文章的背景对象。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `Object`: 页面对象。
### getEditedPostId
> **已弃用**
返回当前编辑的模板或模板部件的ID。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `?string`: 文章ID。
### getEditedPostType
> **已弃用**
返回当前编辑的文章类型wp_template 或 wp_template_part
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `?TemplateType`: 模板类型。
### getEditorMode
返回当前编辑模式。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `string`: 编辑模式。
### getHomeTemplateId
> **已弃用**
### getNavigationPanelActiveMenu
> **已弃用**
### getPage
> **已弃用**
返回当前页面对象。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `Object`: 页面对象。
### getReusableBlocks
返回所有可用的可重用区块。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `Array`: 可用的可重用区块。
### getSettings
返回站点编辑器设置。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `Object`: 设置对象。
### hasPageContentFocus
> **已弃用**
判断编辑器是否仅允许编辑页面内容。
_返回值_
- `boolean`: 是否聚焦于编辑页面内容。
### isFeatureActive
> **已弃用**
返回指定功能是否启用。
_参数_
- _state_ `Object`: 全局应用状态。
- _featureName_ `string`: 功能标识符。
_返回值_
- `boolean`: 是否启用。
### isInserterOpened
> **已弃用**
如果插入器已打开则返回true。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `boolean`: 插入器是否打开。
### isListViewOpened
如果列表视图已打开则返回true。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `boolean`: 列表视图是否打开。
### isNavigationOpened
> **已弃用**
### isPage
> **已弃用**
判断编辑器是否已加载页面。
_相关_
- setPage
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `boolean`: 编辑器是否已加载页面。
### isSaveViewOpened
返回保存面板当前的打开/关闭状态。
_参数_
- _state_ `Object`: 全局应用状态。
_返回值_
- `boolean`: 如果保存面板应打开则为true关闭则为false。
<!-- END TOKEN(Autogenerated selectors|../../../packages/edit-site/src/store/selectors.js) -->
## 操作
<!-- START TOKEN(Autogenerated actions|../../../packages/edit-site/src/store/actions.js) -->
### addTemplate
> **已弃用**
添加新模板并设置为当前模板的操作。
_参数_
- _template_ `Object`: 模板对象。
_返回值_
- `Object`: 用于设置当前模板的操作对象。
### closeGeneralSidebar
关闭侧边栏的操作。
### openGeneralSidebar
打开编辑器侧边栏的操作。
_参数_
- _name_ `?string`: 要打开的侧边栏名称。
### openNavigationPanelToMenu
> **已弃用**
同时打开导航面板并设置其活动菜单。
### removeTemplate
移除模板的操作。
_参数_
- _template_ `Object`: 模板对象。
### revertTemplate
将模板恢复至原始主题提供的文件。
_参数_
- _template_ `Object`: 要恢复的模板。
- _options_ `[Object]`:
- _options.allowUndo_ `[boolean]`: 是否允许用户撤销恢复模板操作。默认为true。
### setEditedEntity
> **已弃用**
设置已编辑实体的操作。
_参数_
- _postType_ `string`: 实体的文章类型。
- _postId_ `string`: 实体的ID。
- _context_ `Object`: 实体的上下文。
_返回值_
- `Object`: 操作对象。
### setEditedPostContext
> **已弃用**
设置当前区块编辑器上下文。
_参数_
- _context_ `Object`: 上下文对象。
_返回值_
- `Object`: 操作对象。
### setHasPageContentFocus
设置编辑器是否仅允许编辑页面内容。
_参数_
- _hasPageContentFocus_ `boolean`: 为true时仅允许编辑页面内容为false时允许编辑模板。
### setHomeTemplateId
> **已弃用**
### setIsInserterOpened
> **已弃用**
返回用于打开/关闭插入器的操作对象。
_参数_
- _value_ `boolean|Object`: 插入器应打开true或关闭false
### setIsListViewOpened
> **已弃用**
返回用于打开/关闭列表视图的操作对象。
_参数_
- _isOpen_ `boolean`: 表示列表视图应打开或关闭的布尔值。
### setIsNavigationPanelOpened
> **已弃用**
设置导航面板是否应打开。
### setIsSaveViewOpened
设置保存视图面板是否应打开。
_参数_
- _isOpen_ `boolean`: 为true时打开保存视图为false时关闭。此操作不切换状态而是直接设置状态。
### setNavigationMenu
> **已弃用**
设置导航菜单的操作。
_参数_
- _navigationMenuId_ `string`: 导航菜单文章ID。
_返回值_
- `Object`: 操作对象。
### setNavigationPanelActiveMenu
> **已弃用**
设置活动导航面板菜单的操作。
_返回值_
- `Object`: 操作对象。
### setPage
> **已弃用**
解析页面模板并同时显示两者。如果未提供路径则尝试使用postId生成类似`?p=${ postId }`的路径。
_返回值_
- `Object`: 操作对象。
### setTemplate
设置模板的操作可选择从REST API获取。
_返回值_
- `Object`: 操作对象。
### setTemplatePart
> **已弃用**
设置模板部件的操作。
_参数_
- _templatePartId_ `string`: 模板部件ID。
_返回值_
- `Object`: 操作对象。
### switchEditorMode
> **已弃用**
触发用于切换编辑器模式的操作。
_参数_
- _mode_ `string`: 编辑器模式。
### toggleDistractionFree
> **已弃用**
切换无干扰模式的操作。无干扰模式下预期无侧边栏因为设置的z-index值会导致无法关闭侧边栏。
### toggleFeature
触发切换功能标志的操作。
_参数_
- _featureName_ `string`: 功能名称。
### updateSettings
返回用于更新设置的操作对象。
_参数_
- _settings_ `Object`: 新设置。
_返回值_
- `Object`: 操作对象。
<!-- END TOKEN(Autogenerated actions|../../../packages/edit-site/src/store/actions.js) -->