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 shortcut parent, NULL is returned.
- If there are multiple possible shortcut parents, a NullPage is returned.
Usage
// basic usage
$page = $templates->getParentPage(Template $template);
// usage with all arguments
$page = $templates->getParentPage(Template $template, bool $checkAccess = false, $getAll = false);Arguments
| Name | Type(s) | Description |
|---|---|---|
template | Template | |
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 |
Return value
$templates methods and properties
API reference based on ProcessWire core version 3.0.214