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.236

Latest news

  • ProcessWire Weekly #525
    In the 525th issue of ProcessWire Weekly we'll cover the latest core updates, check out a couple of modules split from the ProFields module bundle and made freely available via the modules directory, and more. Read on!
    Weekly.pw / 1 June 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK