WordPress 的编辑文章模块。

此包仅用于 WordPress 核心。您可以自由地在自己的项目中使用它,但请记住它可能永远不会得到完全文档化。

安装

安装该模块

npm install @wordpress/edit-post

此包假设您的代码将在ES2015+环境中运行。如果您使用的环境对这类语言特性和 API 支持有限或根本不支持,则应在代码中包含@wordpress/babel-preset-default随附的 polyfill。

扩展文章编辑器界面

可以使用 registerPlugin API 来扩展编辑器界面,允许您将插件的所有 UI 元素定义在一个地方。

有关更多信息,请参阅插件模块文档。

通过 API 导出的组件可以与 registerPlugin(参见文档)API 一起使用。
当将 wp-edit-post 定义为脚本依赖项时,它们可以在全局变量 wp.editPost 中找到。

API

initializeEditor

初始化并返回 Editor 的一个实例。

参数

  • id string:编辑器实例的唯一标识符。
  • postType string:要编辑的文章类型。
  • postId Object:要编辑的文章 ID。
  • settings ?Object:编辑器设置对象。
  • initialEdits Object:初始应用的程序化编辑,被视为非用户发起的操作(绕过未保存更改提示)。

PluginBlockSettingsMenuItem

相关

  • @wordpress/editor 包中的 PluginBlockSettingsMenuItem。

PluginDocumentSettingPanel

相关

  • @wordpress/editor 包中的 PluginDocumentSettingPanel。

PluginMoreMenuItem

相关

  • @wordpress/editor 包中的 PluginMoreMenuItem。

PluginPostPublishPanel

相关

  • @wordpress/editor 包中的 PluginPostPublishPanel。

PluginPostStatusInfo

相关

  • @wordpress/editor 包中的 PluginPostStatusInfo。

PluginPrePublishPanel

相关

  • @wordpress/editor 包中的 PluginPrePublishPanel。

PluginSidebar

相关

  • @wordpress/editor 包中的 PluginSidebar。

PluginSidebarMoreMenuItem

相关

  • @wordpress/editor 包中的 PluginSidebarMoreMenuItem。

reinitializeEditor

用于在错误后重新初始化编辑器。现在它是一个已弃用的空函数。

store

编辑文章命名空间的存储定义。

相关

类型

  • Object

为此包做出贡献

这是 Gutenberg 项目的一部分,是一个独立的包。该项目组织为 monorepo。它由多个自包含的软件包组成,每个包都有特定的用途。此 monorepo 中的包发布到 npm,并被 WordPress 以及其他软件项目使用。

要了解有关为此包或整个 Gutenberg 做出贡献的更多信息,请阅读项目的主要贡献者指南。