$fieldgroups->clone() method

Create and return a cloned copy of this item

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

Usage

// basic usage
$fieldgroup = $fieldgroups->clone(Saveable $item);

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

Arguments

NameType(s)Description
itemSaveable

Item to clone

name (optional)string

Optionally specify new name

Return value

Fieldgroup false

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


Hooking $fieldgroups->clone(…)

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

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

$fieldgroups methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer