paginate

Information about the pagination inside a set of paginate tags.

Tip

Use the default_pagination filter to output pagination links.

Properties

current_offset number: The total number of items on pages previous to the current page.

For example, if you show 5 items per page and are on page 3, then the value of paginate.current_offset is 10.

Limited to 24,999 see Pagination Limits for more information.
current_page number: The page number of the current page.

Limited to 25,000 see Pagination Limits for more information.
items number: The total number of items to be paginated.

For example, if you paginate a collection of 120 products, then the value of paginate.items is 120.

Limited to 25,000 see Pagination Limits for more information.
next part: The pagination part to go to the next page.
page_param string: The URL parameter denoting the pagination.

The default value is page.

If you paginate over an array defined in a setting or a metafield list type, then a unique key is appended to page to allow the paginated list to operate independently from other lists on the page. For example, a paginated list defined in a setting might use the key page_a9e329dc.
page_size number: The number of items displayed per page.

Limited to 250.
pages number: The total number of pages.

Limited to 25,000 see Pagination Limits for more information.
parts array of part: The pagination parts.

Pagination parts are used to build pagination navigation.
previous part: The pagination part to go to the previous page.

{

"current_offset": 10,

"current_page": 3,

"items": 17,

"next": {},

"page_param": "page",

"page_size": 5,

"pages": 4,

"parts": [],

"previous": {}

}

{
  "current_offset": 10,
  "current_page": 3,
  "items": 17,
  "next": {},
  "page_param": "page",
  "page_size": 5,
  "pages": 4,
  "parts": [],
  "previous": {}
}

Was this section helpful?