Skip to content

HTMLPurifier_AttrTransform_SafeEmbed

Processes an entire attribute array for corrections needing multiple values.

Occasionally, a certain attribute will need to be removed and popped onto another value. Instead of creating a complex return syntax for HTMLPurifier_AttrDef, we just pass the whole attribute array to a specialized object and have that do the special work. That is the family of HTMLPurifier_AttrTransform.

An attribute transformation can be assigned to run before or after HTMLPurifier_AttrDef validation. See HTMLPurifier_HTMLDefinition for more details.

Properties

name

public $name

Methods

transform

Abstract: makes changes to the attributes dependent on multiple values.

public transform(array $attr, \HTMLPurifier_Config $config, \HTMLPurifier_Context $context): array

Parameters:

Parameter Type Description
$attr array
$config \HTMLPurifier_Config
$context \HTMLPurifier_Context

Inherited methods

transform

Abstract: makes changes to the attributes dependent on multiple values.

public transform(array $attr, \HTMLPurifier_Config $config, \HTMLPurifier_Context $context): array
  • This method is abstract.

Parameters:

Parameter Type Description
$attr array Assoc array of attributes, usually from
HTMLPurifier_Token_Tag::$attr
$config \HTMLPurifier_Config Mandatory HTMLPurifier_Config object.
$context \HTMLPurifier_Context Mandatory HTMLPurifier_Context object

Return Value:

Processed attribute array.

prependCSS

Prepends CSS properties to the style attribute, creating the attribute if it doesn't exist.

public prependCSS(array& $attr, string $css): mixed

Parameters:

Parameter Type Description
$attr array Attribute array to process (passed by reference)
$css string CSS to prepend

confiscateAttr

Retrieves and removes an attribute

public confiscateAttr(array& $attr, mixed $key): mixed

Parameters:

Parameter Type Description
$attr array Attribute array to process (passed by reference)
$key mixed Key of attribute to confiscate

Automatically generated on 2025-03-18