WordPress中文开发手册

  1. Home
  2. Docs
  3. WordPress中文开发手册
  4. WordPress REST API手册
  5. 使用REST API
  6. 分页

分页

WordPress网站可以拥有大量内容 - 远远超过您希望在单个请求中下拉。 API端点默认为每个请求提供有限数量的项目,与在归档视图中WordPress站点默认为每页10个帖子相同。

分页参数

任何包含多个资源的API响应都支持几个常见的查询参数,以通过响应数据来处理分页:

?page =:指定要返回的结果的页面。
例如/ wp / v2 / posts?page = 2是帖子结果的第二页
通过检索/ wp / v2 / posts,然后/ wp / v2 / posts?page = 2等等,您可以通过API访问每个可用的帖子,一次一页。
?per_page =:指定在一个请求中返回的记录数,指定为1到100之间的整数。
例如,/ wp / v2 / posts?per_page = 1将只返回集合中的第一个帖子
?offset =:指定开始检索帖子的任意偏移量
例如,/ wp / v2 / posts?offset = 6将使用每页的默认帖子数,但从集合中的第6个帖子开始
?per_page = 5&page = 4相当于?per_page = 5&offset = 15
提示:大型查询可能会损害网站性能,因此per_page的上限为100条记录。如果您希望检索超过100条记录,例如构建所有可用类别的客户端列表,您可以创建多个API请求并将结果合并到应用程序中。

要确定有多少页面的数据可用,API返回两个标题字段与每个分页响应:

  • X-WP-Total:集合中的记录总数
  • X-WP-TotalPages:包含所有可用记录的总页数
    通过检查这些标题字段,您可以确定API中有多少数据可用。

订购结果

除了上面详细分析的查询参数之外,其他几个参数控制了返回结果的顺序:

?order =:控制结果是按升序还是降序返回
有效值为?order = asc(升序)和?order = desc(降序)。
默认情况下,所有本地集合都将按降序返回。
?orderby =:控制集合被排序的字段
orderby的有效值将根据查询的资源而有所不同; 对于/ wp / v2 / posts集合,有效值为“date”,“relevance”,“id”,“include”,“title”和“slug”
有关其他集合支持的值,请参阅REST API参考
所有带有日期资源的集合都默认为orderby = date