$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 #527
    In the 527th issue of ProcessWire Weekly we'll check out what's new in the core this week, introduce a new third party module called Lister Calculator, and more. Read on!
    Weekly.pw / 15 June 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

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer