$fields->getNumRows() method

Return a count of database rows populated the given field

Usage

// basic usage
$int = $fields->getNumRows(Field $field);

// usage with all arguments
$int = $fields->getNumRows(Field $field, array $options = []);

Arguments

NameType(s)Description
fieldField
options (optional)array

Optionally specify any of the following options:

  • template (Template|int|string): Specify a Template object, ID or name to isolate returned rows specific to pages using that template.
  • page (Page|int|string): Specify a Page object, ID or path to isolate returned rows specific to that page.
  • countPages (bool): Specify boolean true to make it return a page count rather than a row count (default=false). There will only be potential difference between rows and pages counts with multi-value fields.
  • getPageIDs (bool): Specify boolean true to make it return an array of matching Page IDs rather than a count (overrides countPages).

Return value

int array

Returns array only if getPageIDs option set, otherwise returns a count of rows.

Exceptions

Method can throw exceptions on error:

  • WireException - If given option for page or template doesn't resolve to actual page/template.


$fields methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #556
    In the 556th issue of ProcessWire Weekly we're going to share the latest core development news, highlight a new third party module, and more. Read on!
    Weekly.pw / 4 January 2025
  • 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

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani