Bricks 中文文档：bricks/query_api/headers

标签TAGS:

2026年8月30日

📄 原始资料 | 展开查看原始 JSON（bricks-query_api-headers.json）{ “name”: “bricks/query_api/headers”, “kind”: “filter”, “url”: “https://academy.bricksbuilder.io/developer/hooks/filters/bricks-query_api-headers/”, “scraped_at”: “2026-08-29”, “hook_name”: “bricks/query_api/headers”, “description”: { “e…

📄 原始资料 | 展开查看原始 JSON（bricks-query_api-headers.json）

{
  "name": "bricks/query_api/headers",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-query_api-headers/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query_api/headers",
  "description": {
    "en": "Filters the headers used by a Query API element request before Bricks sends it.",
    "zh": "在 Bricks 发送 Query API 元素请求之前，筛选该请求使用的请求头。"
  },
  "parameters": [
    {
      "name": "headers",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "HTTP request headers.",
        "zh": "HTTP 请求头。"
      }
    },
    {
      "name": "element_id",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The Query API element ID.",
        "zh": "Query API 元素 ID。"
      }
    },
    {
      "name": "query_api",
      "type": "object",
      "type_zh": null,
      "description": {
        "en": "The Query API integration instance.",
        "zh": "Query API 集成实例。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/query_api/headers', function( $headers, $element_id, $query_api ) {\n    $headers['X-Client'] = 'my-site';\n\n\n    return $headers;\n}, 10, 3 );"
}

前言

在 Bricks 发送 Query API 元素请求之前，筛选该请求使用的请求头。

用法

将代码加入子主题的 functions.php：

add_filter( 'bricks/query_api/headers', function( $headers, $element_id, $query_api ) {
    $headers['X-Client'] = 'my-site';


    return $headers;
}, 10, 3 );

参数

$headers (array)：HTTP 请求头。
$element_id (string)：Query API 元素 ID。
$query_api (object)：Query API 集成实例。

示例代码

筛选返回值

add_filter( 'bricks/query_api/headers', function( $headers, $element_id, $query_api ) {
    $headers['X-Client'] = 'my-site';


    return $headers;
}, 10, 3 );

根据条件短路返回原值

根据条件跳过或修改返回值：

add_filter( 'bricks/query_api/headers', function( $value, $headers ) {
    if ( is_admin() ) { return $value; }
    // TODO: custom logic here
    return $value;
} );

补充说明

更多细节可参考官方文档。