Bricks 中文文档:bricks/{object_type}s/query_vars

📄 原始资料  |  展开查看原始 JSON(bricks-object_types-query_vars.json){ “name”: “bricks/{object_type}s/query_vars”, “kind”: “filter”, “url”: “https://academy.bricksbuilder.io/developer/hooks/filters/bricks-object_types-query_vars/”, “scraped_at”: “2026-08-29”, “hook_name”: “bricks/{object_type}s/quer…

📄 原始资料  |  展开查看原始 JSON(bricks-object_types-query_vars.json)
{
  "name": "bricks/{object_type}s/query_vars",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-object_types-query_vars/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/{object_type}s/query_vars",
  "description": {
    "en": "Allows you to modify the query variables for a specific object type query loop. This is a dynamic filter where {$object_type} is replaced by the type of object being queried (e.g., post , term , user ). Common variations:",
    "zh": "允许你修改特定对象类型查询循环的查询变量。这是一个动态筛选器,其中 {$object_type} 会被替换为被查询对象的类型(例如 post、term、user)。常见变体:"
  },
  "parameters": [
    {
      "name": "query_vars",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "The query variables/arguments.",
        "zh": "查询变量/参数。"
      }
    },
    {
      "name": "settings",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "The element settings.",
        "zh": "元素设置。"
      }
    },
    {
      "name": "element_id",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The element ID.",
        "zh": "元素 ID。"
      }
    },
    {
      "name": "element_name",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The element name (available since Bricks 1.11.1).",
        "zh": "元素名称(Bricks 1.11.1 起可用)。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/posts/query_vars', function( $query_vars, $settings, $element_id, $element_name ) {\n    // Only apply to a specific element ID\n    if ( $element_id !== 'brxe-abcdef' ) {\n        return $query_vars;\n    }\n\n\n    // Modify query variables\n    $query_vars['posts_per_page'] = 12;\n\n\n    return $query_vars;\n}, 10, 4 );"
}

前言

允许你修改特定对象类型查询循环的查询变量。这是一个动态筛选器,其中 {$object_type} 会被替换为被查询对象的类型(例如 post、term、user)。常见变体:

用法

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

add_filter( 'bricks/posts/query_vars', function( $query_vars, $settings, $element_id, $element_name ) {
    // Only apply to a specific element ID
    if ( $element_id !== 'brxe-abcdef' ) {
        return $query_vars;
    }


    // Modify query variables
    $query_vars['posts_per_page'] = 12;


    return $query_vars;
}, 10, 4 );

参数

  • $query_vars (array):查询变量/参数。
  • $settings (array):元素设置。
  • $element_id (string):元素 ID。
  • $element_name (string):元素名称(Bricks 1.11.1 起可用)。

示例代码

筛选返回值

add_filter( 'bricks/posts/query_vars', function( $query_vars, $settings, $element_id, $element_name ) {
    // Only apply to a specific element ID
    if ( $element_id !== 'brxe-abcdef' ) {
        return $query_vars;
    }


    // Modify query variables
    $query_vars['posts_per_page'] = 12;


    return $query_vars;
}, 10, 4 );

根据条件短路返回原值

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

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

补充说明

更多细节可参考 官方文档