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 #552
    In the 552nd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, take a quick look at a new e-commerce solution for ProcessWire, and more. Read on!
    Weekly.pw / 7 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK