$page->numDescendants() method

Return number of descendants (children, grandchildren, great-grandchildren, …), optionally with conditions

Use this over the $page->numDescendants property when you want to specify a selector or apply some other filter to the result (see options for $selector argument). If you want to include only visible descendants specify a selector (string or array) or boolean true for the $selector argument, if you don’t need a selector.

If you want to find descendant pages (rather than count), use the Page::find() method.

Example

// Find how many descendants were modified in the last week
$qty = $page->numDescendants("modified>='-1 WEEK'");

Usage

// basic usage
$int = $page->numDescendants();

// usage with all arguments
$int = $page->numDescendants($selector = null);

Arguments

NameType(s)Description
selector (optional)

Return value

int

Number of descendants

See Also


$page 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

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer