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

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull