WireMail::sanitizeHeaderName() method
Sanitize and normalize a header name
This protected method is for hooks to monitor and it is likely not intended to be called directly.
Available since version 3.0.132.
Internal usage
$string = $m->sanitizeHeaderName(string $name);Arguments
| Name | Type(s) | Description |
|---|---|---|
$name | string |
Return value
string
Hooking $m→sanitizeHeaderName(…)
You can add your own hook events that are executed either before or after the $m->sanitizeHeaderName(…) 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 $m->sanitizeHeaderName(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('WireMail::sanitizeHeaderName', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$WireMail = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$name = $event->arguments(0);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $name);
}); Hooking after
The 'after' hooks are called immediately after each $m->sanitizeHeaderName(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('WireMail::sanitizeHeaderName', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$WireMail = $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)
$name = $event->arguments(0);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
}); API reference based on ProcessWire core version 3.0.252