Bricks 中文文档：bricks/query/result_start

标签TAGS: 
2026年8月30日

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

📄 原始资料  |  展开查看原始 JSON（bricks-query-result_start.json） 
{
  "name": "bricks/query/result_start",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-query-result_start/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query/result_start",
  "description": {
    "en": "Filters the starting index used when slicing the query results. This allows you to control where the displayed results begin, useful for custom offsets or pagination.",
    "zh": "筛选用于切片查询结果的起始索引。允许你控制显示结果从何处开始，可用于自定义偏移或分页。"
  },
  "parameters": [
    {
      "name": "start",
      "type": "int",
      "type_zh": null,
      "description": {
        "en": "The starting index for the result slice.",
        "zh": "结果切片的起始索引。"
      }
    },
    {
      "name": "query",
      "type": "object",
      "type_zh": null,
      "description": {
        "en": "The Bricks Query instance.",
        "zh": "Bricks 查询实例。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/query/result_start', function( $start, $query ) {\n    // Example: Offset results by 1 for a specific query ID\n    if ( $query->id === 'my_offset_query' ) {\n        return $start + 1;\n    }\n\n\n    return $start;\n}, 10, 2 );"
}

前言

筛选用于切片查询结果的起始索引。允许你控制显示结果从何处开始，可用于自定义偏移或分页。

用法

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

add_filter( 'bricks/query/result_start', function( $start, $query ) {
    // Example: Offset results by 1 for a specific query ID
    if ( $query->id === 'my_offset_query' ) {
        return $start + 1;
    }


    return $start;
}, 10, 2 );

参数

  • $start (int)：结果切片的起始索引。
  • $query (object)：Bricks 查询实例。

示例代码

筛选返回值

add_filter( 'bricks/query/result_start', function( $start, $query ) {
    // Example: Offset results by 1 for a specific query ID
    if ( $query->id === 'my_offset_query' ) {
        return $start + 1;
    }


    return $start;
}, 10, 2 );

根据条件短路返回原值

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

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

补充说明

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