WordPress中文开发手册

全局参数

API包括一些控制API如何处理请求/响应处理的全局参数（也称为“元参数”）。 它们在实际资源本身以上的层次上运行，并且在所有资源上可用。

_jsonp

API原生支持JSONP响应，以允许传统浏览器和客户端的跨域请求。 此参数需要一个JavaScript回调函数，它将被添加到数据中。 然后可以通过<script>标签加载该URL。

回调函数可以包含任何字母数字，_（下划线）或。 （期）字。 包含无效字符的回调将收到HTTP 400错误响应，不会调用回调。

注意：现代浏览器可以使用跨域请求的跨原始资源共享（CORS）预检要求，但可以使用JSONP来确保所有浏览器的支持。

浏览器支持
关于CORS的MDN文章
例如：

<script>
function receiveData( data ) {
  // Do something with the data here.
  // For demonstration purposes, we'll simply log it.
  console.log( data );
}
</script>
<script src="https://demo.wp-api.org/wp-json/?_jsonp=receiveData"></script>

_method （或X-HTTP-Method-Override标题）

某些服务器和客户端无法正确处理API使用的一些HTTP方法。 例如，对资源的所有删除请求都使用DELETE方法，但有些客户端不提供发送此方法的功能。

为了确保与这些服务器和客户端的兼容性，API支持方法覆盖。 这可以通过_method参数或X-HTTP-Method-Override标头传递，其值设置为要使用的HTTP方法。

警报：客户端应该只发送具有POST请求的方法覆盖参数或头。 使用GET请求的方法覆盖可能会导致请求被错误地缓存。

一个POST到/ wp-json / wp / v2 / posts / 42？_method = DELETE将被转换为DELETE到wp / v2 / posts / 42路由。

类似地，以下POST请求将成为DELETE：

POST /wp-json/wp/v2/posts/42 HTTP/1.1
Host: example.com
X-HTTP-Method-Override: DELETE

_envelope

与_method类似，一些服务器，客户端和代理不支持访问完整的响应数据。 API支持传递一个_envelope参数，该参数发送正文中的所有响应数据，包括头文件和状态代码。

如果在查询字符串（GET参数）中传递了_envelope参数，则启用信封模式。 该参数不需要一个值（即？_envelope有效），但如果客户端库需要，可以将其作为值“1”传递。

注意：为了将来的兼容性，不应该传递其他值。

包含的回应包括一个“假的”HTTP 200响应代码，没有额外的标头（Content-Type除外），应该确保响应正确地通过中介。

例如，给予对wp / v2 / users / me的GET的以下响应：

HTTP/1.1 302 Found
Location: http://example.com/wp-json/wp/v2/users/42
 
{
  "id": 42,
  ...
}

等效的包络响应（使用GET到wp / v2 / users / me？_envelope）将是：

HTTP/1.1 200 OK
 
{
  "status": 302,
  "headers": {
    "Location": "http://example.com/wp-json/wp/v2/users/42"
  },
  "body": {
    "id": 42
  }
}

_embed

大多数资源包括相关资源的链接。 例如，一个帖子可以链接到父帖子，或者发表评论。 为了减少所需的HTTP请求数量，客户端可能希望获取资源以及链接的资源。 _embed参数向服务器指示响应应包括这些嵌入式资源。

如果在查询字符串（GET参数）中传递了_embed参数，则嵌入模式被启用。 该参数不需要一个值（即__embed是有效的），但是如果客户端库需要，则可以将“1”作为值传递。

注意：为了将来的兼容性，不应该传递其他值。

嵌入模式中的资源将在包含链接资源的_links键旁边包含一个附加的_embedded键。 将嵌入嵌入式参数设置为true的链接。

有关链接和嵌入的更多信息，请参阅链接和嵌入页面。

快速导航