Paginate links 格式介绍

概述

Pagination（分页）是在网站中常见的一种数据展示方式，即将大量数据拆分成若干小份进行展示，方便用户查看。WordPress 也提供了相关的 API（Application Programming Interface，应用程序接口），其中 paginate_links 是其中一个用于生成分页链接的函数。

paginate_links 函数

paginate_links 是 WordPress 中一个用于生成分页链接的函数，可以根据不同的参数生成不同的链接格式，返回 HTML 格式的链接列表。

用法

<?php
global $wp_query;
$big = 999999999; // 很大的数字，用于保证链接不会和文章 ID 冲突
echo paginate_links( array(
    'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
    'format' => '?paged=%#%',
    'prev_text' => '上一页',
    'next_text' => '下一页',
    'total' => $wp_query->max_num_pages,
    'current' => max( 1, get_query_var( 'paged' ) ),
) );
?>

参数说明

以下是常用参数的说明：

• base：分页链接的格式，默认为当前页面 URL 加上 <a> 标签；
• format：分页链接中页码的显示格式，%#% 表示页码；
• prev_text：上一页链接的文字；
• next_text：下一页链接的文字；
• total：总页数；
• current：当前页数。

更多参数可以查看 WordPress 的官方文档：paginate_links。

分页链接格式

paginate_links 可以生成多种样式的分页链接，以下是常见的样式：

• %#%：页码；
• %#paged%：页码（带前缀 paged）；
• %pagename%：当前页面 URL 中的页面名称（即通过 Page Slug 方式创建的页面）；
• %author%：当前文章的作者；
• %year%：当前文章的发布年份；
• %monthnum%：当前文章的发布月份；
• %day%：当前文章的发布日期；
• %hour%：当前文章的发布时间（小时）；
• %minute%：当前文章的发布时间（分钟）；
• %category%：当前文章所属的分类；
• %postname%：当前文章的 URL 路径。

以上参数可以通过 add_rewrite_tag 函数添加到 WordPress 的 permalink 中。

返回值

paginate_links 函数返回的是一个 HTML 格式的链接列表：

<div class="pagination">
    <a class="prev page-numbers" href="#">上一页</a>
    <span class="page-numbers current">1</span>
    <a class="page-numbers" href="#">2</a>
    <a class="page-numbers" href="#">3</a>
    <a class="page-numbers" href="#">4</a>
    <a class="page-numbers" href="#">5</a>
    <a class="next page-numbers" href="#">下一页</a>
</div>

总结

paginate_links 是 WordPress 中用于生成分页链接的函数，可以根据不同的参数生成不同的链接格式，返回 HTML 格式的链接列表。在 WordPress 开发中，特别是在自定义主题中，使用 paginate_links 可以方便地生成分页链接，提高用户体验。