$templates→getParentPage()

Return the parent page that this template assumes new pages are added to

  • This is based on family settings, when applicable.
  • It also takes into account user access, if requested (see arg 1).
  • If there is no defined parent, NULL is returned.
  • If there are multiple defined parents, a NullPage is returned (use $getAll to get them).

Usage

// basic usage
$page = $templates->getParentPage(Template $template);

// usage with all arguments
$page = $templates->getParentPage(Template $template, bool $checkAccess = false, $getAll = false);

Arguments

NameType(s)Description
$templateTemplate
$checkAccess (optional)bool

Whether or not to check for user access to do this Default:false

$getAll (optional)bool int

Specify true to return all possible parents (makes method always return a PageArray) Or specify int of maximum allowed Page::status* constant for items in returned PageArray 3.0.138.

Return value

Page NullPage null PageArray

$templates methods and properties

API reference based on ProcessWire core version 3.0.252