PaginatedArray class

PaginatedArray is a type of WireArray that supports pagination of items within it.

Here you will see methods specific to the pagination aspects of this class only. For full details on available methods outside of pagination, please see the WireArray class. The most common type of PaginatedArray is a PageArray.


Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the PaginatedArray class also inherits all the methods and properties of: WireArray and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
PaginatedArray::renderPager()
string) Renders pagination, when MarkupPageArray module installed

Retrieval

NameReturnSummary 
PaginatedArray::getLimit()
intGet the limit that was used in pagination. 
PaginatedArray::getStart()
intGet the starting offset number that was used for pagination. 
PaginatedArray::getTotal()
intGet the total number of items in the WireArray, including all paginations. 

Manipulation

Additional methods and properties

In addition to the methods and properties above, PaginatedArray also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.200

Twitter updates

    Nothing to show

Latest news

  • ProcessWire Weekly #438
    In the 348th issue of ProcessWire Weekly we're going to cover the latest weekly update from Ryan, take a closer look at a couple of new third party modules, and more. Read on!
    Weekly.pw / 1 October 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.