Bricks 中文文档：bricks/query_api/body

标签TAGS: 
2026年8月30日

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

📄 原始资料  |  展开查看原始 JSON（bricks-query_api-body.json） 
{
  "name": "bricks/query_api/body",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-query_api-body/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query_api/body",
  "description": {
    "en": "Filters the body data used by a Query API element request before Bricks adds it to the HTTP request. Bricks only builds a body for request methods that support one in the Query API implementation, currently POST .",
    "zh": "在 Bricks 将请求体添加到 HTTP 请求之前，筛选 Query API 元素请求使用的主体数据。Bricks 仅为支持请求体的请求方法（当前为 POST）构建请求体。"
  },
  "parameters": [
    {
      "name": "body_data",
      "type": "string|array|null",
      "type_zh": null,
      "description": {
        "en": "The request body data Bricks has built.",
        "zh": "Bricks 已构建的请求体数据。"
      }
    },
    {
      "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/body', function( $body_data, $element_id, $query_api ) {\n    return $body_data;\n}, 10, 3 );"
}

前言

在 Bricks 将请求体添加到 HTTP 请求之前，筛选 Query API 元素请求使用的主体数据。Bricks 仅为支持请求体的请求方法（当前为 POST）构建请求体。

用法

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

add_filter( 'bricks/query_api/body', function( $body_data, $element_id, $query_api ) {
    return $body_data;
}, 10, 3 );

参数

  • $body_data (string|array|null)：Bricks 已构建的请求体数据。
  • $element_id (string)：Query API 元素 ID。
  • $query_api (object)：Query API 集成实例。

示例代码

筛选返回值

add_filter( 'bricks/query_api/body', function( $body_data, $element_id, $query_api ) {
    return $body_data;
}, 10, 3 );

根据条件短路返回原值

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

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

补充说明

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