Delete the given Field from all pages using the given template, without loading those pages.
ProcessWire will use this method rather than deletePageField in cases where the quantity of items to delete is high (above 200 at time this was written). However, if your individual Fieldtype defines it's own ___deletePageField method (separate from the one above) then it'll still get used.
This was added so that mass deletions can happen without loading every page, which may not be feasible when dealing with thousands of pages.
Usage
$bool = $fieldtype->deleteTemplateField(Template $template, Field $field);
Arguments
Name | Type(s) | Description |
---|---|---|
template | Template | |
field | Field |
Return value
bool
Hooking Fieldtype::deleteTemplateField(…)
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('Fieldtype::deleteTemplateField', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$Fieldtype = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$template = $event->arguments(0);
$field = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $template);
$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('Fieldtype::deleteTemplateField', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$Fieldtype = $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)
$template = $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;
});
Fieldtype methods and properties
API reference based on ProcessWire core version 3.0.236