$fields→saveFieldgroupContext()
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
| Name | Type(s) | Description |
|---|---|---|
$field | Field | Field to save context for |
$fieldgroup | Fieldgroup | Context for when field is in this fieldgroup |
$namespace (optional) | string | An optional namespace for additional context |
Return value
boolTrue 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 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 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 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.255