FormBuilderEntries::save() method
Save the given form entry
If it is an existing entry that should be updated, then it should have a populated 'id' property otherwise it will be inserted as a new entry.
Usage
$int = $entries->save(array $entry);
Arguments
Name | Type(s) | Description |
---|---|---|
$entry | array |
Return value
int
bool
entry ID on success, false if not
Exceptions
Method can throw exceptions on error:
FormBuilderException
- on failure
Hooking $entries→save(…)
You can add your own hook events that are executed either before or after the $entries->save(…)
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->save(…)
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FormBuilderEntries::save', 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)
$entry = $event->arguments(0);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $entry);
});
Hooking after
The 'after' hooks are called immediately after each $entries->save(…)
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::save', 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)
$entry = $event->arguments(0);
/* 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.251