REST API 手册

WordPress REST API 为应用程序提供了一个接口,通过发送和接收JSON(JavaScript 对象表示法)对象形式的数据来与您的 WordPress 站点进行交互。它是WordPress Block Editor的基础,同样可以使您的主题、插件或自定义应用程序提供新的、强大的界面来管理和发布您的网站内容。

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

REST API 是 WordPress 面向开发人员的功能。它提供对您网站内容的数据访问,并实施相同的身份验证限制——您网站上公开的内容通常可以通过 REST API 公开访问,而私有内容、受密码保护的内容、内部用户、自定义帖子类型、并且元数据仅在身份验证时可用,或者如果您专门将其设置为如此。如果您不是开发人员,了解该 API 最重要的一点是它可以启用块编辑器和现代插件界面,而不会损害您网站的安全或隐私。

什么是 REST API?

API 是应用程序编程接口。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 的压力。您不需要使用 REST API 来构建 WordPress 主题或插件。

但是,如果您确实希望将主题、插件或外部应用程序编写为客户端 JavaScript 应用程序,或使用 PHP 以外的语言编写的独立程序,那么您的应用程序将需要一种结构化的方式来访问 WordPress 站点中的内容. 任何可以发出 HTTP 请求和解释 JSON 的编程语言都可以使用 REST API 与 WordPress 交互,从 PHP、Node.js、Go 和 Java,到 Swift、Kotlin 等等。

admin-ajax即使您在主题或插件中使用 vanilla JavaScript 或 jQuery ,REST API 也提供了一种比 .经验。

如果您想要一种结构化、可扩展且简单的方式将数据传入和传出 WordPress,您可能需要使用 REST API。

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

下一步

熟悉REST API 功能背后的关键技术概念。

在使用 REST API部分了解有关如何与 API 资源交互和查询特定数据的更多信息。

一旦您对默认路由和方法的默认工作方式感到满意,就可以在扩展 REST API部分了解如何向 API 添加新数据或增强和操作现有响应对象。

如需全面了解默认情况下可用的资源和路由,请查看API 参考。