Bricks 中文文档：bricks/query/run_fake

标签TAGS: 
2026年8月30日

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

📄 原始资料  |  展开查看原始 JSON（bricks-query-run_fake.json） 
{
  "name": "bricks/query/run_fake",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-query-run_fake/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query/run_fake",
  "description": {
    "en": "Defines the results of a “fake” query execution for custom or unsupported query types. This is used when calculating filter counts or other logic that requires querying all potential results without pagination.",
    "zh": "为自定义或不支持的查询类型定义“伪”查询执行的结果。用于在计算筛选计数或其他需要查询所有潜在结果而不分页的逻辑时。"
  },
  "parameters": [
    {
      "name": "results",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "The query results array (default [] ).",
        "zh": "查询结果数组（默认为 []）。"
      }
    },
    {
      "name": "query",
      "type": "object",
      "type_zh": null,
      "description": {
        "en": "The Bricks Query instance.",
        "zh": "Bricks 查询实例。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/query/run_fake', function( $results, $query ) {\n    // Example: Provide all results for a custom 'my_api' query type\n    if ( $query->object_type === 'my_api' ) {\n        // Fetch all IDs from your API\n        return [ 1, 2, 3, 4, 5 ];\n    }\n\n\n    return $results;\n}, 10, 2 );"
}

前言

为自定义或不支持的查询类型定义“伪”查询执行的结果。用于在计算筛选计数或其他需要查询所有潜在结果而不分页的逻辑时。

用法

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

add_filter( 'bricks/query/run_fake', function( $results, $query ) {
    // Example: Provide all results for a custom 'my_api' query type
    if ( $query->object_type === 'my_api' ) {
        // Fetch all IDs from your API
        return [ 1, 2, 3, 4, 5 ];
    }


    return $results;
}, 10, 2 );

参数

  • $results (array)：查询结果数组（默认为 []）。
  • $query (object)：Bricks 查询实例。

示例代码

筛选返回值

add_filter( 'bricks/query/run_fake', function( $results, $query ) {
    // Example: Provide all results for a custom 'my_api' query type
    if ( $query->object_type === 'my_api' ) {
        // Fetch all IDs from your API
        return [ 1, 2, 3, 4, 5 ];
    }


    return $results;
}, 10, 2 );

根据条件短路返回原值

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

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

补充说明

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