$fields->getNumPages() method

Return a count of pages containing populated values for the given field

Usage

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

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

Arguments

NameType(s)Description
fieldField
options (optional)array

Optionally specify one 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.
  • getPageIDs (bool): Specify boolean true to make it return an array of matching Page IDs rather than a count.

Return value

int array

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

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 #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 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

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH