Per the Fieldtype interface, Save the given Field from the given Page to the database
Because the number of values may have changed, this method plays it safe and deletes all the old values and reinserts them as new.
Usage
$bool = $fieldtypeComments->savePageField(Page $page, Field $field);
Arguments
Name | Type(s) | Description |
---|---|---|
page | Page | Page object to save. |
field | Field | Field to retrieve from the page. |
Return value
bool
True on success, false on DB save failure.
Exceptions
Method can throw exceptions on error:
\PDOException
orWireException
orWireDatabaseQueryException
- on failure
Hooking FieldtypeComments::savePageField(…)
You can add your own hook events that are executed either before or after the Fieldtype
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 Fieldtype
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FieldtypeComments::savePageField', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FieldtypeComments = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$page = $event->arguments(0);
$field = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $page);
$event->arguments(1, $field);
});
Hooking after
The 'after' hooks are called immediately after each Fieldtype
method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('FieldtypeComments::savePageField', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FieldtypeComments = $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)
$page = $event->arguments(0);
$field = $event->arguments(1);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
});
FieldtypeComments methods and properties
API reference based on ProcessWire core version 3.0.236