API results for “template”
$templates->getExportData(Template $template) apivar.method
Export Template data for external use
$templates->setImportData(Template $template, array $data) apivar.method
Given an array of Template export data, import it to the given Template
$templates->getParentPage(Template $template, bool $checkAccess = false, $getAll = false) apivar.method
Return the parent page that this template assumes new pages are added to
$templates->getParentPages(Template $template, bool $checkAccess = false, int $maxStatus = 0) apivar.method
Return all possible parent pages for the given template, if predefined
$templates->getPageClass(Template $template, bool $withNamespace = true) apivar.method
Get class name to use for pages using given Template
$templates->getTags(bool $getTemplateNames = false) apivar.method
Get all tags used by templates
$templates->fileModified(Template $template) apivar.method
Hook called when a Template detects that its file has changed
$pages->add($template, $parent, string $name = '', array $values = []) apivar.method
Add a new page using the given template and parent
$pages->getById($_ids, $template = null, $parent_id = null) apivar.method
Given an array or CSV string of Page IDs, return a PageArray (internal API)
$pages->templateChanged(Page $page) apivar.method
Hook called when a page's template has been changed
$user->hasTemplatePermission($name, $template) apivar.method
Does this user have the given permission on the given template?
Process::installPage(string $name = '', $parent = null, string $title = '', $template = 'admin', array $extras = []) apivar.method
Install a dedicated page for this Process module and assign it this Process
$page->template($template = null) apivar.method
Get or set template
$page->renderField(string $fieldName, string $file = '', $value = null) apivar.method
Render given field using site/templates/fields/ markup file
$page->renderValue(mixed $value, string $file = '') apivar.method
Render given value using /site/templates/fields/ markup file
$page->is($status) apivar.method
Does this page have the specified status number or template name?
$page->getAccessTemplate(string $type = 'view') apivar.method
Returns the template from which role/access settings are inherited from
viewable($field = '', $checkTemplateFile = true) apivar.method
Returns true if the page (and optionally field) is viewable by the current user, false if not.
templates($name = '') class.method
Access the $templates API variable as a function.
$page->template($template = null) class.method
Get or set template
$page->renderField(string $fieldName, string $file = '', $value = null) class.method
Render given field using site/templates/fields/ markup file
$page->renderValue(mixed $value, string $file = '') class.method
Render given value using /site/templates/fields/ markup file
$page->is($status) class.method
Does this page have the specified status number or template name?
$page->getAccessTemplate(string $type = 'view') class.method
Returns the template from which role/access settings are inherited from
viewable($field = '', $checkTemplateFile = true) class.method
Returns true if the page (and optionally field) is viewable by the current user, false if not.