The paginate object

The paginate tag's navigation is built using the attributes of the paginate object. You can also use the default_pagination filter for a quicker alternative.

The paginate object has the following attributes:

paginate.current_offset

Returns the total number of items that are on the pages previous to the current one. For example, if you are paginating by 5 and are on the third page, paginate.current_offset would return 10.

paginate.current_page

Returns the number of the current page.

paginate.items

Returns the total number of items to be paginated. For example, if you are paginating a collection of 120 products, paginate.items would return 120.

paginate.parts

Returns an array of all parts of the pagination. A part is a component used to build the navigation for the pagination.

paginate.next

Returns the part variable for the Next link in the pagination navigation.

paginate.previous

Returns the part variable for the Previous link in the pagination navigation.

paginate.page_size

Returns the number of items displayed per page.

paginate.pages

Returns the number of pages created by the pagination tag.