$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 #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • 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.