$pages->findIDs() method

Like find() except returns array of IDs rather than Page objects

  • This is a faster method to use when you only need to know the matching page IDs.
  • The default behavior is to simply return a regular PHP array of matching page IDs in order.
  • The alternate behavior (verbose) returns more information for each match, as outlined below.

Verbose option:
When specifying boolean true for the $options argument (or using the verbose option), the return value is an array of associative arrays, with each of those associative arrays containing id, parent_id and templates_id keys for each page.

Available since version 3.0.46.

Example

// returns array of page IDs (integers) like [ 1234, 1235, 1236 ]
$a = $pages->findIDs("foo=bar");

// verbose option: returns array of associative arrays, each with id, parent_id and templates_id
$a = $pages->findIDs("foo=bar", true);

Usage

// basic usage
$array = $pages->findIDs($selector);

// usage with all arguments
$array = $pages->findIDs($selector, $options = []);

Arguments

NameType(s)Description
selectorstring, array, Selectors

Selector to find page IDs.

options (optional)array, bool, int, string

Options to modify behavior.

  • verbose (bool|int|string): Specify true to make return value array of associative arrays, each with id, parent_id, templates_id. Specify integer 2 or string * to return verbose array of associative arrays, each with all columns from pages table.
  • indexed (bool): Index by page ID? (default=false) Added 3.0.172
  • The verbose option above can also be specified as alternative to the $options argument.
  • See Pages::find() $options argument for additional options.

Return value

array

Array of page IDs, or in verbose mode: array of arrays, each with id, parent_id and templates_id keys.


$pages methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 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

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