MarkupHTMLPurifier::initConfig()

Method to allow hooks to further initialize HTMLPurifier config/settings

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Available since version 3.0.173.

Example

$wire->addHook('MarkupHTMLPurifier::initConfig', function($event) {
  $def = $event->arguments(1);
  $def->addAttribute('a', 'data-ext', 'Text');
}); 

Internal usage

$markupHTMLPurifier->initConfig(\HTMLPurifier_Config $settings, \HTMLPurifier_HTMLDefinition $def);

Arguments

NameType(s)Description
$settings\HTMLPurifier_Config
$def\HTMLPurifier_HTMLDefinition

Hooking MarkupHTMLPurifier::initConfig(…)

You can add your own hook events that are executed either before or after the MarkupHTMLPurifier::initConfig(…) 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 MarkupHTMLPurifier::initConfig(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('MarkupHTMLPurifier::initConfig', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $MarkupHTMLPurifier = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $settings = $event->arguments(0);
  $def = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $settings);
  $event->arguments(1, $def);
});

Hooking after

The 'after' hooks are called immediately after each MarkupHTMLPurifier::initConfig(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('MarkupHTMLPurifier::initConfig', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $MarkupHTMLPurifier = $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)
  $settings = $event->arguments(0);
  $def = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

MarkupHTMLPurifier methods and properties

API reference based on ProcessWire core version 3.0.251