钩子文档

rest_exposed_cors_headers

💡 云策文档标注

概述

rest_exposed_cors_headers 是一个 WordPress 过滤器,用于控制哪些响应头在 REST API 的 CORS 请求中被暴露。它允许开发者自定义暴露的响应头列表,以增强 API 的安全性和灵活性。

关键要点

  • 这是一个过滤器,用于修改 REST API CORS 请求中暴露的响应头列表。
  • 接受两个参数:$expose_headers(字符串数组,要暴露的响应头列表)和 $request(WP_REST_Request 对象,当前请求上下文)。
  • 在 WordPress 6.3.0 版本中新增了 $request 参数,5.5.0 版本引入此过滤器。
  • 常用于 WP_REST_Server::serve_request() 方法中,处理 REST API 请求。

代码示例

$expose_headers = apply_filters( 'rest_exposed_cors_headers', $expose_headers, $request );

📄 原文内容

Filters the list of response headers that are exposed to REST API CORS requests.

Parameters

$expose_headersstring[]
The list of response headers to expose.
$requestWP_REST_Request
The request in context.

Source

$expose_headers = apply_filters( 'rest_exposed_cors_headers', $expose_headers, $request );

Changelog

Version Description
6.3.0 The $request parameter was added.
5.5.0 Introduced.