paginate_links_output
云策文档标注
概述
paginate_links_output 是一个 WordPress 过滤器,用于修改归档页面分页链接的 HTML 输出。它允许开发者自定义分页链接的呈现方式,基于 paginate_links() 函数的参数。
关键要点
- 过滤器名称:paginate_links_output
- 作用:过滤归档分页链接的 HTML 输出
- 参数:$r(HTML 输出字符串)和 $args(参数数组,与 paginate_links() 兼容)
- 引入版本:WordPress 5.7.0
- 相关函数:paginate_links(),用于生成分页链接
代码示例
$r = apply_filters( 'paginate_links_output', $r, $args );注意事项
- $args 参数支持 paginate_links() 的所有参数,如 base、format、total、current 等,用于控制分页行为。
- 开发者可以通过此过滤器调整分页链接的样式、结构或添加自定义内容。
原文内容
Filters the HTML output of paginated links for archives.
Parameters
$rstring-
HTML output.
$argsarray-
An array of arguments. See paginate_links() for information on accepted arguments.
More Arguments from paginate_links( … $args )
Array or string of arguments for generating paginated links for archives.
basestringBase of the paginated url. Default empty.formatstringFormat for the pagination structure. Default empty.totalintThe total amount of pages. Default is the value WP_Query‘smax_num_pagesor 1.currentintThe current page number. Default is'paged'query var or 1.aria_currentstringThe value for the aria-current attribute. Possible values are'page','step','location','date','time','true','false'. Default is'page'.show_allboolWhether to show all pages. Default false.end_sizeintHow many numbers on either the start and the end list edges.
Default 1.mid_sizeintHow many numbers to either side of the current pages. Default 2.prev_nextboolWhether to include the previous and next links in the list. Default true.prev_textstringThe previous page text. Default ‘« Previous’.next_textstringThe next page text. Default ‘Next »’.typestringControls format of the returned value. Possible values are'plain','array'and'list'. Default is'plain'.add_argsarrayAn array of query args to add. Default false.add_fragmentstringA string to append to each link. Default empty.before_page_numberstringA string to appear before the page number. Default empty.after_page_numberstringA string to append after the page number. Default empty.
Source
$r = apply_filters( 'paginate_links_output', $r, $args );
Changelog
| Version | Description |
|---|---|
| 5.7.0 | Introduced. |