11 KiB
11 KiB
core/edit-post 存储库
私有选择器：
getEditedPostTemplateId
edit-site
core/edit-site 存储库
私有操作：
registerRoutesetEditorCanvasContainerView
私有选择器：
getRoutesgetEditorCanvasContainerView
Gutenberg 私有 API
本文概述了 Gutenberg 包暴露的私有 API。这些 API 用于实现 Gutenberg 编辑器（文章编辑器、站点编辑器、核心区块及其他功能）的组成部分，但未向插件和主题开发者或自定义 Gutenberg 集成的开发者公开。
本文档旨在展示我们拥有多少私有 API，以及如何利用 @wordpress/* 系列包提供的库和框架来构建 Gutenberg 编辑器应用。
data
注册器包含两个私有方法：
privateActionsOfprivateSelectorsOf
每个存储库均提供用于注册私有选择器/操作的私有 API：
privateActionsregisterPrivateActionsprivateSelectorsregisterPrivateSelectors
blocks
core/blocks 存储库
私有操作：
addBlockBindingsSourceremoveBlockBindingsSourceaddBootstrappedBlockTypeaddUnprocessedBlockType
私有选择器：
getAllBlockBindingsSourcesgetBlockBindingsSourcegetBootstrappedBlockTypegetSupportedStylesgetUnprocessedBlockTypeshasContentRoleAttribute
components
私有导出项：
__experimentalPopoverLegacyPositionToPlacementComponentsContextTabsThemeMenukebabCase
commands
私有导出项：
useCommandContext（2023 年 5 月通过 #50543 添加）
core/commands 存储库
私有操作：
setContext（与useCommandContext同时添加）
preferences
私有导出项（2024 年 1 月通过 #57639 添加）：
PreferenceBaseOptionPreferenceToggleControlPreferencesModalPreferencesModalSectionPreferencesModalTabs
仅有一个公开导出的组件！
PreferenceToggleMenuItem
block-editor
私有导出项：
AdvancedPanelBackgroundPanelBorderPanelColorPanelDimensionsPanelFiltersPanelGlobalStylesContextImageSettingsPanelTypographyPanelareGlobalStyleConfigsEqualgetBlockCSSSelectorgetBlockSelectorsgetGlobalStylesChangesgetLayoutStylestoStylesuseGlobalSettinguseGlobalStyleuseGlobalStylesOutputuseGlobalStylesOutputWithConfiguseGlobalStylesResetuseHasBackgroundPaneluseHasBorderPaneluseHasBorderPanelControlsuseHasColorPaneluseHasDimensionsPaneluseHasFiltersPaneluseHasImageSettingsPaneluseHasTypographyPaneluseSettingsForBlockElementExperimentalBlockCanvas：公共BlockCanvas的变体，包含多个额外属性：contentRef、shouldIframe、iframeProps。ExperimentalBlockEditorProvider：公共BlockEditorProvider的变体，过滤掉若干私有/实验性设置。另请参阅__experimentalUpdateSettings。getDuotoneFiltergetRichTextValuesPrivateQuickInserterextractWordsgetNormalizedSearchTermsnormalizeStringPrivateListViewResizableBoxPopoverBlockInfouseHasBlockToolbarcleanEmptyObjectBlockQuickNavigationLayoutStyleBlockRemovalWarningModaluseLayoutClassesuseLayoutStylesDimensionsToolResolutionToolTabbedSidebarTextAlignmentControlusesContextKeyuseFlashEditableBlocksuseZoomOutglobalStylesDataKeyglobalStylesLinksDataKeyselectBlockPatternsKeyrequiresWrapperOnCopyPrivateRichText：额外属性readOnly于 #58916 和 #60327（2024 年 2 月和 3 月）添加。PrivateInserterLibrary：额外属性onPatternCategorySelection于 #62130（2024 年 5 月）添加。reusableBlocksSelectKeyPrivateBlockPopover：包含两个额外属性__unstableContentRef和__unstablePopoverSlot。PrivatePublishDateTimePicker：公共PublishDateTimePicker的变体，包含两个额外属性：isCompact和showPopoverHeaderActions。useSpacingSizesuseBlockDisplayTitle__unstableBlockStyleVariationOverridesWithConfigsetBackgroundStyleDefaultssectionRootClientIdKey__unstableCommentIconFill__unstableCommentIconToolbarFill
core/block-editor 存储库
私有操作：
__experimentalUpdateSettings：公共updateSettings操作的实验版本，用于过滤部分私有/实验性设置。clearBlockRemovalPrompt：清除区块移除提示deleteStyleOverride：删除样式覆盖ensureDefaultBlock：确保默认区块存在expandBlock：展开区块hideBlockInterface：隐藏区块界面modifyContentLockBlock：修改内容锁定区块privateRemoveBlocks：私有移除区块resetZoomLevel：重置缩放级别setBlockRemovalRules：设置区块移除规则setInsertionPoint：设置插入点setLastFocus：设置最后焦点setOpenedBlockSettingsMenu：设置已打开的区块设置菜单setStyleOverride：设置样式覆盖setZoomLevel：设置缩放级别showBlockInterface：显示区块界面startDragging：开始拖拽stopDragging：停止拖拽stopEditingAsBlocks：停止以区块形式编辑
私有选择器：
getAllPatterns：获取所有模式getBlockRemovalRules：获取区块移除规则getBlockSettings：获取区块设置getBlockStyles：获取区块样式getBlockWithoutAttributes：获取无属性区块getClosestAllowedInsertionPoint：获取最近允许插入点getClosestAllowedInsertionPointForPattern：获取模式最近允许插入点getContentLockingParent：获取内容锁定父级getEnabledBlockParents：获取启用区块父级getEnabledClientIdsTree：获取启用的客户端ID树getExpandedBlock：获取已展开区块getInserterMediaCategories：获取插入器媒体分类getInsertionPoint：获取插入点getLastFocus：获取最后焦点getLastInsertedBlocksClientIds：获取最后插入区块客户端IDgetOpenedBlockSettingsMenu：获取已打开区块设置菜单getParentSectionBlock：获取父级区块区域getPatternBySlug：通过别名获取模式getRegisteredInserterMediaCategories：获取已注册插入器媒体分类getRemovalPromptData：获取移除提示数据getReusableBlocks：获取可重用区块getSectionRootClientId：获取区域根客户端IDgetStyleOverrides：获取样式覆盖getTemporarilyEditingAsBlocks：获取临时以区块形式编辑状态getTemporarilyEditingFocusModeToRevert：获取待恢复的临时编辑焦点模式getZoomLevel：获取缩放级别hasAllowedPatterns：检查是否存在允许模式isBlockInterfaceHidden：检查区块界面是否隐藏isBlockSubtreeDisabled：检查区块子树是否禁用isDragging：检查是否正在拖拽isResolvingPatterns：检查是否正在解析模式isSectionBlock：检查是否为区域区块isZoomOut：检查是否处于缩小状态
core-data
私有导出：
useEntityRecordsWithPermissions：带权限的实体记录钩子
core 存储库
私有操作：
receiveRegisteredPostMeta：接收已注册文章元数据editMediaEntity：编辑媒体实体
私有选择器：
getBlockPatternsForPostType：获取文章类型区块模式getEntityRecordPermissions：获取实体记录权限getEntityRecordsPermissions：获取实体记录集权限getNavigationFallbackId：获取导航回退IDgetRegisteredPostMeta：获取已注册文章元数据getUndoManager：获取撤销管理器
patterns（2023年8月创建的包，无公开导出，所有内容均为私有）
私有导出：
OverridesPanel：覆盖面板CreatePatternModal：创建模式模态框CreatePatternModalContents：创建模式模态框内容DuplicatePatternModal：复制模式模态框isOverridableBlock：检查是否为可覆盖区块hasOverridableBlocks：检查是否存在可覆盖区块useDuplicatePatternProps：复制模式属性钩子RenamePatternModal：重命名模式模态框PatternsMenuItems：模式菜单项RenamePatternCategoryModal：重命名模式分类模态框PatternOverridesControls：模式覆盖控件ResetOverridesControl：重置覆盖控件PatternOverridesBlockControls：模式覆盖区块控件useAddPatternCategory：添加模式分类钩子PATTERN_TYPES：模式类型PATTERN_DEFAULT_CATEGORY：模式默认分类PATTERN_USER_CATEGORY：模式用户分类EXCLUDED_PATTERN_SOURCES：排除的模式来源PATTERN_SYNC_TYPES：模式同步类型PARTIAL_SYNCING_SUPPORTED_BLOCKS：支持部分同步的区块
core/patterns 存储库
私有操作：
convertSyncedPatternToStatic：将同步模式转换为静态createPattern：创建模式createPatternFromFile：从文件创建模式setEditingPattern：设置编辑模式
私有选择器：
isEditingPattern：检查是否正在编辑模式
block-library
私有导出：
BlockKeyboardShortcuts：区块键盘快捷键
router（仅私有导出）
私有导出：
useHistory：历史记录钩子useLocation：位置钩子RouterProvider：路由提供者
core-commands（仅私有导出）
私有导出：
useCommands：命令钩子
editor
私有导出：
CreateTemplatePartModal：创建模板部件模态框BackButton：返回按钮EntitiesSavedStatesExtensible：可扩展实体保存状态Editor：编辑器EditorContentSlotFill：编辑器内容插槽填充GlobalStylesProvider：全局样式提供者mergeBaseAndUserConfigs：合并基础与用户配置PluginPostExcerpt：插件文章摘要PostCardPanel：文章卡片面板PreferencesModal：偏好设置模态框usePostActions：文章操作钩子ToolsMoreMenuGroup：工具更多菜单组ViewMoreMenuGroup：视图更多菜单组ResizableEditor：可调整大小编辑器registerCoreBlockBindingsSources：注册核心区块绑定源interfaceStore：界面存储库ActionItem：操作项ComplementaryArea：补充区域ComplementaryAreaMoreMenuItem：补充区域更多菜单项FullscreenMode：全屏模式InterfaceSkeleton：界面骨架PinnedItems：固定项目
core/editor 存储库
私有操作：
createTemplate：创建模板hideBlockTypes：隐藏区块类型registerEntityAction：注册实体操作registerPostTypeActions：注册文章类型操作removeTemplates：移除模板revertTemplate：恢复模板saveDirtyEntities：保存未保存实体setCurrentTemplateId：设置当前模板IDsetIsReady：设置就绪状态showBlockTypes：显示区块类型unregisterEntityAction：取消注册实体操作
私有选择器：
getEntityActions：获取实体操作getInserter：获取插入器getInserterSidebarToggleRef：获取插入器侧边栏切换引用getListViewToggleRef：获取列表视图切换引用getPostBlocksByName：通过名称获取文章区块getPostIcon：获取文章图标hasPostMetaChanges：检查文章元数据是否有变更isEntityReady：检查实体是否就绪