PaginatedArray::getProperty() method

Get a property of the PageArray

These map to functions from the array and are here for convenience. Properties include count, total, start, limit, last, first, keys, values, These can also be accessed by direct reference, i.e. $items->limit.

Please see the WireArray::getProperty() method for full details on non-pagination related properties that can be retrieved through this.

Example

// Get count
$count = $items->getProperty('count');

// Same as above using direct access property
$count = $items->count; 

Usage

$mixed = $paginatedArray->getProperty(string $property);

Arguments

NameType(s)Description
propertystring

Name of property you want to retrieve, can be any of the following:

  • count (int): Count of items currently present.
  • total (int): Total quantity of items across all paginations.
  • start (int): Current start index for pagination.
  • limit (int): Current limit used for pagination.
  • last (mixed): Last item in the WireArray.
  • first (mixed): First item in the WireArray.

Return value

mixed

Value of requested property.


PaginatedArray methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #581
    The 581st issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 28 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • 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.