WordPress REST API 为应用程序提供了一个接口,使其能够通过发送和接收 JSON(JavaScript 对象表示法)对象与您的 WordPress 站点进行交互。它是 WordPress 区块编辑器 的基础,同样也可以让您的主题、插件或自定义应用程序呈现全新的强大界面,用于管理和发布您的站点内容。

使用 WordPress REST API,您可以创建一个插件,为 WordPress 提供全新的管理体验;构建一个全新的交互式前端体验;或者将您的 WordPress 内容引入完全独立的应用程序中。

REST API 是 WordPress 面向开发人员的功能。它提供对您站点内容的数据访问,并实施相同的身份验证限制——站点上公开的内容通常可以通过 REST API 公开访问,而私有内容、密码保护的内容、内部用户、自定义文章类型和元数据仅在通过身份验证或您明确设置时才可用。如果您不是开发人员,关于该 API 最重要的一点是:它使区块编辑器和现代插件界面成为可能,同时不会损害您站点的隐私和安全。

什么是 REST API?

API 是应用程序编程接口(Application Programming Interface)。REST 代表“表述性状态转移”(REpresentational State Transfer),是一组用于将应用程序的数据建模为相互关联的对象和集合并进行访问的概念集。WordPress REST API 提供了代表帖子、页面、分类法和其他内置 WordPress 数据类型的 REST 端点(URL)。您的应用程序可以向这些端点发送和接收 JSON 数据,以查询、修改和创建您站点上的内容。JSON 是一种开放的标准数据格式,轻量且易于人类阅读,其外观类似于 JavaScript 中的对象。当您从 API 请求内容或向 API 发送内容时,响应也将以 JSON 格式返回。由于 JSON 在多种编程语言中得到了广泛支持,开发人员可以使用客户端 JavaScript(如区块编辑器)、移动应用程序,或桌面及命令行工具来构建 WordPress 应用程序。

REST API 只是 WordPress 提供的众多 API 之一。您可以在此处找到关于这些额外 API 的文档。

使用 WordPress REST API

WordPress 已经提供了丰富的工具和接口集用于构建站点,如果您的站点已按预期工作,则不应感到有压力去使用 REST API。构建 WordPress 主题或插件并不需要强制使用 REST API。

然而,如果您确实希望将您的主题、插件或外部应用程序编写为客户端 JavaScript 应用程序,或是使用 PHP 以外的语言编写的独立程序,那么您的应用程序就需要一种结构化的方式来访问 WordPress 站点内的内容。任何能够发起 HTTP 请求并解析 JSON 的编程语言都可以使用 REST API 与 WordPress 进行交互,无论是 PHP、Node.js、Go 和 Java,还是 Swift、Kotlin 以及其他语言。

即使您在主题或插件中使用原生 JavaScript 或 jQuery,REST API 也比 admin-ajax 提供了一种更可预测和结构化的方式来与您的站点内容进行交互,让您能花更少的时间获取所需数据,而将更多时间用于创造更好的用户体验。

如果您想要一种结构化、可扩展且简单的方式来进出 WordPress 获取数据,那么您可能应该使用 REST API。

尽管 REST API 非常简单,但起初可能会让人觉得相当复杂,因此在本手册中,我们将尝试将其分解为更小的组件,以解释完整拼图中的每一部分。

下一步

熟悉 REST API 运作背后的关键技术概念。

在 使用 REST API 章节中,了解更多关于如何与 API 资源交互以及查询特定数据的方法。

一旦您对默认路由和方法的默认工作方式感到得心应手,可以在 扩展 REST API 章节中发现如何向 API 添加新数据,或增强和操作现有的响应对象。

为了全面了解默认可用的资源和路由,请查阅 API 参考。