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

Twitter updates

  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020

Latest news

  • ProcessWire Weekly #333
    In the 333rd issue of ProcessWire Weekly we'll check out what's new in the latest dev version of ProcessWire, 3.0.167, and more. Read on!
    Weekly.pw / 26 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer