$templatesnew()

Create and save a new Template and Fieldgroup

Available since version 3.0.258.

Example

$template = $templates->new('product', 'Product item');

Usage

// basic usage
$template = $templates->new($name);

// usage with all arguments
$template = $templates->new($name, $settings = []);

Arguments

NameType(s)Description
$namestring array

Name of template or array of settings that includes 'name', and anything else that would usually go in $settings array.

$settings (optional)array string

Array of settings to set, or string for template label only

Return value

Exceptions

Method can throw exceptions on error:

  • WireException - If given a template name that already exists


Hooking $templates→new(…)

You can add your own hook events that are executed either before or after the $templates->new(…) 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->new(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Templates::new', 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)
  $name = $event->arguments(0);
  $settings = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $templates->new(…) 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::new', 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)
  $name = $event->arguments(0);
  $settings = $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.259