$templates->setImportData() method

Given an array of Template export data, import it to the given Template

Example

// Example of return value
$returnValue = array(
  'property_name' => array(
    'old' => 'old value', // old value (in string comparison format)
    'new' => 'new value', // new value (in string comparison format)
    'error' => 'error message or blank if no error' // error message (string) or messages (array)
  ),
  'another_property_name' => array(
    // ...
  )
);

Usage

$array = $templates->setImportData(Template $template, array $data);

Arguments

NameType(s)Description
templateTemplate

Template you want to import to

dataarray

Import data array (must have been exported from getExportData() method).

Return value

array

Returns array with list of changes (see example in method description)


Hooking $templates->setImportData(…)

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

$this->addHookBefore('Templates::setImportData', 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)
  $template = $event->arguments(0);
  $data = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $templates->setImportData(…) 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::setImportData', 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)
  $template = $event->arguments(0);
  $data = $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.200

Twitter updates

  • New post: Multi-language field translation export/import — In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire… More
    5 August 2022
  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022
  • Weekly update for July 22– Looking back at what web development was like in the year 2000. Plus some more discussion on the path from CKEditor 4 to CkEditor 5 in ProcessWire: More
    22 July 2022

Latest news

  • ProcessWire Weekly #430
    In the 430th issue of ProcessWire Weekly we're going to check out some brand new third party modules, a new site of the week, and more. Read on!
    Weekly.pw / 7 August 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits