Bricks 中文文档：bricks/query/query_api_response

标签TAGS: 
2026年8月30日

📄 原始资料  |  展开查看原始 JSON（bricks-query-query_api_response.json）{ “name”: “bricks/query/query_api_response”, “kind”: “action”, “url”: “https://academy.bricksbuilder.io/developer/hooks/actions/bricks-query-query_api_response/”, “scraped_at”: “2026-08-29”, “hook_name”: “bricks/query/query_api_re…

📄 原始资料  |  展开查看原始 JSON（bricks-query-query_api_response.json） 
{
  "name": "bricks/query/query_api_response",
  "kind": "action",
  "url": "https://academy.bricksbuilder.io/developer/hooks/actions/bricks-query-query_api_response/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query/query_api_response",
  "description": {
    "en": "Runs after a Query API request is performed. This action allows you to inspect or process the response from the API query.",
    "zh": "Query API 请求执行完毕后触发。此动作允许你查看或处理 API 查询的响应。"
  },
  "parameters": [
    {
      "name": "response",
      "type": "array|WP_Error",
      "type_zh": null,
      "description": {
        "en": "The response from the API request.",
        "zh": "API 请求的响应。"
      }
    },
    {
      "name": "element_id",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The element ID associated with the query.",
        "zh": "与查询相关联的元素 ID。"
      }
    }
  ],
  "example_usage": "add_action( 'bricks/query/query_api_response', function( $response, $element_id ) {\n    if ( is_wp_error( $response ) ) {\n        error_log( 'Query API Error for element ' . $element_id . ': ' . $response->get_error_message() );\n        return;\n    }\n\n\n    // Process successful response\n    // $data = $response;\n    // Do something with $data\n}, 10, 2 );"
}

前言

Query API 请求执行完毕后触发。此动作允许你查看或处理 API 查询的响应。

用法

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

add_action( 'bricks/query/query_api_response', function( $response, $element_id ) {
    if ( is_wp_error( $response ) ) {
        error_log( 'Query API Error for element ' . $element_id . ': ' . $response->get_error_message() );
        return;
    }


    // Process successful response
    // $data = $response;
    // Do something with $data
}, 10, 2 );

参数

  • $response (array|WP_Error)：API 请求的响应。
  • $element_id (string)：与查询相关联的元素 ID。

示例代码

官方示例用法

add_action( 'bricks/query/query_api_response', function( $response, $element_id ) {
    if ( is_wp_error( $response ) ) {
        error_log( 'Query API Error for element ' . $element_id . ': ' . $response->get_error_message() );
        return;
    }


    // Process successful response
    // $data = $response;
    // Do something with $data
}, 10, 2 );

根据条件短路返回原值

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

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

补充说明

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