Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Newsletter
- Plugins
- Roadmap
- Releases
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Presets
- Fields
- Sections
- Blocks
- Icons
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $blocks
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Options
- Urls
- Roots
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- Query
- Server
- Str
- Tpl
- Url
- V
- Xml

new Pagination()

Creates a new pagination object with the given parameters
$pagination->clone()

Creates an instance with the same initial properties.
$pagination->end()

Returns the index of the last item on the page
$pagination->firstPage()

Returns the first page
Pagination::for()

Creates a pagination instance for the given collection with a flexible argument api
$pagination->hardcopy()

Creates a clone and fetches all lazy-loaded getters to get a full copy
$pagination->hasNextPage()

Checks if there's a next page
$pagination->hasPage()

Checks if the given page exists
$pagination->hasPages()

Checks if there are any pages at all
$pagination->hasPrevPage()

Checks if there's a previous page
$pagination->isFirstPage()

Checks if the current page is the first page
$pagination->isLastPage()

Checks if the current page is the last page
$pagination->lastPage()

Returns the last page
$pagination->limit()

Getter for the number of items per page
$pagination->nextPage()

Returns the next page
$pagination->offset()

Returns the offset (i.e. for db queries)
$pagination->page()

Getter for the current page
$pagination->pages()

Returns the total number of pages
$pagination->prevPage()

Returns the previous page
$pagination->range()

Creates a range of page numbers for Google-like pagination
$pagination->rangeEnd()

Returns the last page of the created range
$pagination->rangeStart()

Returns the first page of the created range
$pagination->start()

Returns the index of the first item on the page
$pagination->toArray()

Returns an array with all properties
$pagination->total()

Getter for the total number of items

$pagination->page()

Getter for the current page

kirby/src/Toolkit/Pagination.php#L131

$pagination->page(): int

Return type

int

Parent class

Kirby\Toolkit\Pagination

Did you find an error? Help us improve our docs and edit this page on Github. Make sure to check out our styleguide →