FormBuilderEntries::saveField() method
Update a single form field value for an existing entry
Available since version 0.3.8.
Usage
$bool = $entries->saveField(int $id, string $name, mixed $value);Arguments
| Name | Type(s) | Description |
|---|---|---|
$id | int | Entry ID |
$name | string | Name of field to update |
$value | mixed | Value for field |
Return value
boolTrue on success, false on fail
Hooking $entries→saveField(…)
You can add your own hook events that are executed either before or after the $entries->saveField(…) 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 $entries->saveField(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FormBuilderEntries::saveField', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FormBuilderEntries = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$id = $event->arguments(0);
$name = $event->arguments(1);
$value = $event->arguments(2);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $id);
$event->arguments(1, $name);
$event->arguments(2, $value);
}); Hooking after
The 'after' hooks are called immediately after each $entries->saveField(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('FormBuilderEntries::saveField', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FormBuilderEntries = $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)
$id = $event->arguments(0);
$name = $event->arguments(1);
$value = $event->arguments(2);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
}); $entries methods and properties
API reference based on ProcessWire core version 3.0.252