$templates API variable / Templates class

Manages and provides access to all the Templates.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Templates class also inherits all the methods and properties of: WireSaveableItems and Wire.

Common

Name	Return	Summary
$templates->add() $templates->add(string $name) $templates->add(string $name, array $properties = [])	`Template`	Add and save new template (and fieldgroup) with given name and return it
$templates->clone() $templates->clone($item) $templates->clone($item, string $name = '')	`bool` `Template`	Clone the given Template
$templates->delete() $templates->delete($item) $templates->delete($item)	`bool`	Delete a Template
$templates->get() $templates->get($key) $templates->get($key)	`Template` `null` `string`	Get a template by name or ID
$templates->getNumPages() $templates->getNumPages(Template $tpl) $templates->getNumPages(Template $tpl)	`int`	Return the number of pages using the provided Template
$templates->getPageClass() $templates->getPageClass(Template $template) $templates->getPageClass(Template $template, bool $withNamespace = true)	`string`	Get class name to use for pages using given Template
$templates->getParentPage() $templates->getParentPage(Template $template) $templates->getParentPage(Template $template, bool $checkAccess = false, $getAll = false)	`Page` `NullPage` `null` `PageArray`	Return the parent page that this template assumes new pages are added to
$templates->getParentPages() $templates->getParentPages(Template $template) $templates->getParentPages(Template $template, bool $checkAccess = false, int $maxStatus = 0)	`PageArray`	Return all possible parent pages for the given template, if predefined
$templates->getTags() $templates->getTags() $templates->getTags(bool $getTemplateNames = false)	`array`	Get all tags used by templates
$templates->rename() $templates->rename(Template $template, string $name) $templates->rename(Template $template, string $name)	(nothing)	Rename given template (and its fieldgroup, and file, when possible)
$templates->save() $templates->save($item) $templates->save($item)	`bool`	Save a Template

Advanced

Name	Return	Summary
$templates->getExportData() $templates->getExportData(Template $template) $templates->getExportData(Template $template)	`array`	Export Template data for external use
$templates->setImportData() $templates->setImportData(Template $template, array $data) $templates->setImportData(Template $template, array $data)	`array`	Given an array of Template export data, import it to the given Template

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
$templates->fileModified() $templates->fileModified(Template $template) $templates->fileModified(Template $template)	(nothing)	Hook called when a Template detects that its file has changed

Additional methods and properties

In addition to the methods and properties above, Templates also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.244

$templates API variable / Templates class

Manages and provides access to all the Templates.

Common

Advanced

For hooks

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news