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 Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the In addition to the methods and properties above, PaginatedWireArray
class. The most common type of
PaginatedPageArray
.Paginated
class also inherits all the methods and properties of: WireArray and Wire.Common
Name Return Summary string
) Renders pagination, when MarkupPageArray module installed Retrieval
Name Return Summary int
Get the limit that was used in pagination. int
Get the starting offset number that was used for pagination. int
Get the total number of items in the WireArray, including all paginations. Manipulation
Name Return Summary $this
Set the limit that was used in pagination. $this
Set the starting offset number to use for pagination. $this
Set the total number of items, if more than are in the WireArray. Other
Name Return Summary string
Get a "1 to 10 of 50" type of string useful for pagination headlines. mixed
Get a property of the PageArray bool
Is there a next pagination containing more items in this Paginated bool
Does this WireArray have more than one pagination? bool
Is there a previous pagination before the current one? Additional methods and properties
API reference based on ProcessWire core version 3.0.236