Bricks 中文文档：bricks/woocommerce/predefined_elements/generated_payload

标签TAGS:

2026年8月30日

📄 原始资料 | 展开查看原始 JSON（bricks-woocommerce-predefined_elements-generated_payload.json）{ “name”: “bricks/woocommerce/predefined_elements/generated_payload”, “kind”: “filter”, “url”: “https://academy.bricksbuilder.io/developer/hooks/filters/bricks-woocommerce-predefined_elements-generated_pay…

📄 原始资料 | 展开查看原始 JSON（bricks-woocommerce-predefined_elements-generated_payload.json）

{
  "name": "bricks/woocommerce/predefined_elements/generated_payload",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-woocommerce-predefined_elements-generated_payload/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/woocommerce/predefined_elements/generated_payload",
  "description": {
    "en": "Filters a generated WooCommerce predefined element payload before Bricks returns it.",
    "zh": "在 Bricks 返回生成的 WooCommerce 预定义元素载荷之前，对其进行筛选。"
  },
  "parameters": [
    {
      "name": "response",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "The generated payload response.",
        "zh": "已生成的载荷响应。"
      }
    },
    {
      "name": "preset",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The preset ID being generated.",
        "zh": "正在生成的预设 ID。"
      }
    },
    {
      "name": "context",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "Generation context for the preset.",
        "zh": "预设的生成上下文。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/woocommerce/predefined_elements/generated_payload', function( $response, $preset, $context ) {\n    return $response;\n}, 10, 3 );"
}

前言

在 Bricks 返回生成的 WooCommerce 预定义元素载荷之前，对其进行筛选。

用法

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

add_filter( 'bricks/woocommerce/predefined_elements/generated_payload', function( $response, $preset, $context ) {
    return $response;
}, 10, 3 );

参数

$response (array)：已生成的载荷响应。
$preset (string)：正在生成的预设 ID。
$context (array)：预设的生成上下文。

示例代码

筛选返回值

add_filter( 'bricks/woocommerce/predefined_elements/generated_payload', function( $response, $preset, $context ) {
    return $response;
}, 10, 3 );

根据条件短路返回原值

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

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

补充说明

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