ProcessTemplate::executeSaveFieldgroup() method

Save the fieldgroup

May be called from a POST action, or from the executeFieldgroup() method directly. When called from the executeFieldgroup() method, a fieldgroup param should be provided.

Usage

// basic usage
$processTemplate->executeSaveFieldgroup();

// usage with all arguments
$processTemplate->executeSaveFieldgroup(Fieldgroup $fieldgroup = null);

Arguments

NameType(s)Description
fieldgroup (optional)Fieldgroup

Optional

Exceptions

Method can throw exceptions on error:

  • WireCSRFException


Hooking ProcessTemplate::executeSaveFieldgroup(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each ProcessTemplate::executeSaveFieldgroup(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProcessTemplate::executeSaveFieldgroup', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessTemplate = $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)
  $fieldgroup = $event->arguments(0);

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

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

ProcessTemplate methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer