$fields->saveFieldgroupContext() method

Save the context of the given field for the given fieldgroup

Usage

// basic usage
$bool = $fields->saveFieldgroupContext(Field $field, Fieldgroup $fieldgroup);

// usage with all arguments
$bool = $fields->saveFieldgroupContext(Field $field, Fieldgroup $fieldgroup, string $namespace = '');

Arguments

NameType(s)Description
fieldField

Field to save context for

fieldgroupFieldgroup

Context for when field is in this fieldgroup

namespace (optional)string

An optional namespace for additional context

Return value

bool

True on success

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking $fields->saveFieldgroupContext(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $fields->saveFieldgroupContext(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Fields::saveFieldgroupContext', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fields = $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)
  $field = $event->arguments(0);
  $fieldgroup = $event->arguments(1);
  $namespace = $event->arguments(2);

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

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

$fields methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • 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
  • ProcessWire 3.0.203 core updates: new support for custom fields on comments and more— More
    15 July 2022

Latest news

  • ProcessWire Weekly #429
    In the 429th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module, and more. Read on!
    Weekly.pw / 30 July 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani