WireSaveableItems::clone() method

Create and return a cloned copy of this item

If no name is specified and the new item uses a 'name' field, it will contain a number at the end to make it unique

Usage

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

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

Arguments

Name	Type(s)	Description
`item`	Saveable	Item to clone
`name` (optional)	string	Optionally specify new name

Return value

bool Saveable

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

Hooking WireSaveableItems::clone(…)

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

$this->addHookBefore('WireSaveableItems::clone', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireSaveableItems = $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 WireSaveableItems::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('WireSaveableItems::clone', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireSaveableItems = $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;
});

WireSaveableItems methods and properties

API reference based on ProcessWire core version 3.0.244