$templates->clone() method

Clone the given Template

Note that this also clones the Fieldgroup if the template being cloned has its own named fieldgroup.

Usage

// basic usage
$bool = $templates->clone($item);

// usage with all arguments
$bool = $templates->clone($item, string $name = '');

Arguments

NameType(s)Description
itemTemplate, Saveable

Template to clone

name (optional)string

Name of new template that will be created, or omit to auto-assign.

Return value

bool Template

$item Returns the new Template on success, or false on failure


Hooking $templates->clone(…)

You can add your own hook events that are executed either before or after the $templates->clone(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $templates->clone(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Templates::clone', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $templates = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $item = $event->arguments(0);
  $name = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $item);
  $event->arguments(1, $name);
});

Hooking after

The 'after' hooks are called immediately after each $templates->clone(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Templates::clone', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $templates = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $item = $event->arguments(0);
  $name = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$templates methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #579
    The 579th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 14 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani