Bricks 中文文档:bricks/paginate_links_args

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

📄 原始资料  |  展开查看原始 JSON(bricks-paginate_links_args.json)
{
  "name": "bricks/paginate_links_args",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-paginate_links_args/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/paginate_links_args",
  "description": {
    "en": "Filters the arguments passed to the WordPress paginate_links() function when generating pagination output. This allows you to customize the pagination structure, text labels, and other settings.",
    "zh": "筛选生成分页输出时传递给 WordPress paginate_links() 函数的参数。允许你自定义分页结构、文本标签和其它设置。"
  },
  "parameters": [
    {
      "name": "args",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "Array of arguments for paginate_links() .",
        "zh": "paginate_links() 的参数数组。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/paginate_links_args', function( $args ) {\n    // Example: Change the \"Previous\" and \"Next\" text\n    $args['prev_text'] = 'Previous';\n    $args['next_text'] = 'Next';\n\n\n    // Example: Change the number of adjacent page links shown\n    $args['mid_size'] = 3;\n\n\n    return $args;\n} );"
}

前言

筛选生成分页输出时传递给 WordPress paginate_links() 函数的参数。允许你自定义分页结构、文本标签和其它设置。

用法

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

add_filter( 'bricks/paginate_links_args', function( $args ) {
    // Example: Change the "Previous" and "Next" text
    $args['prev_text'] = 'Previous';
    $args['next_text'] = 'Next';


    // Example: Change the number of adjacent page links shown
    $args['mid_size'] = 3;


    return $args;
} );

参数

  • $args (array):paginate_links() 的参数数组。

示例代码

筛选返回值

add_filter( 'bricks/paginate_links_args', function( $args ) {
    // Example: Change the "Previous" and "Next" text
    $args['prev_text'] = 'Previous';
    $args['next_text'] = 'Next';


    // Example: Change the number of adjacent page links shown
    $args['mid_size'] = 3;


    return $args;
} );

根据条件短路返回原值

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

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

补充说明

更多细节可参考 官方文档