Bricks 中文文档:bricks/query/result_end

标签TAGS: 

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

📄 原始资料  |  展开查看原始 JSON(bricks-query-result_end.json)
{
  "name": "bricks/query/result_end",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-query-result_end/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query/result_end",
  "description": {
    "en": "Filters the ending index used when slicing the query results. This allows you to control which portion of the results is displayed, useful for custom pagination or limit logic.",
    "zh": "筛选用于切片查询结果的结束索引。允许你控制显示结果的哪一部分,可用于自定义分页或限制逻辑。"
  },
  "parameters": [
    {
      "name": "end",
      "type": "int",
      "type_zh": null,
      "description": {
        "en": "The ending 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_end', function( $end, $query ) {\n    // Example: Limit results to 5 for a specific query ID\n    if ( $query->id === 'my_limited_query' ) {\n        return 5;\n    }\n\n\n    return $end;\n}, 10, 2 );"
}

前言

筛选用于切片查询结果的结束索引。允许你控制显示结果的哪一部分,可用于自定义分页或限制逻辑。

用法

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

add_filter( 'bricks/query/result_end', function( $end, $query ) {
    // Example: Limit results to 5 for a specific query ID
    if ( $query->id === 'my_limited_query' ) {
        return 5;
    }


    return $end;
}, 10, 2 );

参数

  • $end (int):结果切片的结束索引。
  • $query (object):Bricks 查询实例。

示例代码

筛选返回值

add_filter( 'bricks/query/result_end', function( $end, $query ) {
    // Example: Limit results to 5 for a specific query ID
    if ( $query->id === 'my_limited_query' ) {
        return 5;
    }


    return $end;
}, 10, 2 );

根据条件短路返回原值

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

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

补充说明

更多细节可参考 官方文档