FormBuilderEntries::delete() method
Delete a form entry by ID
Usage
$int = $entries->delete(int $id);
Arguments
Name | Type(s) | Description |
---|---|---|
$id | int | ID of form entry |
Return value
int
bool
ID of entry that was deleted or false on failure
Hooking $entries→delete(…)
You can add your own hook events that are executed either before or after the $entries->delete(…)
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->delete(…)
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FormBuilderEntries::delete', 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);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $id);
});
Hooking after
The 'after' hooks are called immediately after each $entries->delete(…)
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::delete', 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);
/* 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