$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.

Show $var?             Show args?        

Common

NameReturnSummary 
$templates->add(string $name)
TemplateAdd and save new template (and fieldgroup) with given name and return it 
$templates->clone($item)
bool Saveable TemplateClone the given Template
$templates->delete($item)
boolDelete a Template
$templates->get($key)
Template null stringGet a template by name or ID 
$templates->getNumPages(Template $tpl)
intReturn the number of pages using the provided Template 
$templates->getPageClass(Template $template)
stringGet class name to use for pages using given Template 
$templates->getParentPage(Template $template)
Page NullPage null PageArrayReturn the parent page that this template assumes new pages are added to 
$templates->getParentPages(Template $template)
PageArrayReturn all possible parent pages for the given template, if predefined 
$templates->rename(Template $template, string $name)
(nothing)Rename given template (and its fieldgroup, and file, when possible) 
$templates->save($item)
boolSave a Template

For hooks

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

NameReturnSummary 
$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.172

Twitter updates

  • This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings— More
    5 February 2021
  • ProcessWire 3.0.171 dev branch core updates – More
    22 January 2021
  • Preliminary 2021 roadmap in progress in this week’s update— More
    8 January 2021

Latest news

  • ProcessWire Weekly #352
    In the 352nd issue of ProcessWire Weekly we're going to check out the latest core updates available in ProcessWire 3.0.172, introduce a neat third party module called Admin Autosize Textareas, and more. Read on!
    Weekly.pw / 6 February 2021
  • ProcessWire 3.0.172 – Find faster and more efficiently
    This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings.
    Blog / 5 February 2021
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull