Bricks 中文文档：bricks/query_filters/get_filter_object_ids

标签TAGS:

2026年8月30日

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

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

{
  "name": "bricks/query_filters/get_filter_object_ids",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-query_filters-get_filter_object_ids/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query_filters/get_filter_object_ids",
  "description": {
    "en": "Filters the object IDs used to build query filter counts. Use it when an integration needs to supply or alter the base object IDs for a query/filter source.",
    "zh": "筛选用于构建查询筛选计数的对象 ID。当集成需要提供或更改查询/筛选源的基对象 ID 时使用。"
  },
  "parameters": [
    {
      "name": "all_object_ids",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "The object IDs Bricks has collected.",
        "zh": "Bricks 已收集的对象 ID。"
      }
    },
    {
      "name": "query_id",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The query element ID.",
        "zh": "查询元素 ID。"
      }
    },
    {
      "name": "query_type",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The query type being processed.",
        "zh": "正在被处理的查询类型。"
      }
    },
    {
      "name": "source",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The filter source.",
        "zh": "筛选源。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/query_filters/get_filter_object_ids', function( $all_object_ids, $query_id, $query_type, $source ) {\n    return $all_object_ids;\n}, 10, 4 );"
}

前言

筛选用于构建查询筛选计数的对象 ID。当集成需要提供或更改查询/筛选源的基对象 ID 时使用。

用法

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

add_filter( 'bricks/query_filters/get_filter_object_ids', function( $all_object_ids, $query_id, $query_type, $source ) {
    return $all_object_ids;
}, 10, 4 );

参数

$all_object_ids (array)：Bricks 已收集的对象 ID。
$query_id (string)：查询元素 ID。
$query_type (string)：正在被处理的查询类型。
$source (string)：筛选源。

示例代码

筛选返回值

add_filter( 'bricks/query_filters/get_filter_object_ids', function( $all_object_ids, $query_id, $query_type, $source ) {
    return $all_object_ids;
}, 10, 4 );

根据条件短路返回原值

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

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

补充说明

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