HTMLPurifier_ChildDef_Optional

Definition that allows a set of elements, and allows no children.

• Full name: \HTMLPurifier_ChildDef_Optional
• Parent class: \HTMLPurifier_ChildDef_Required

Properties

allow_empty

Indicates whether or not an empty array of children is okay.

public $allow_empty

---

type

Type of child definition, usually right-most part of class name lowercase.

public $type

---

Methods

validateChildren

Validates nodes according to definition and returns modification.

public validateChildren(array $children, \HTMLPurifier_Config $config, \HTMLPurifier_Context $context): array

Parameters:

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

---

Inherited methods

getAllowedElements

Get lookup of tag names that should not close this element automatically.

public getAllowedElements(\HTMLPurifier_Config $config): array

All other elements will do so.

Parameters:

Parameter	Type	Description
$config	\HTMLPurifier_Config	HTMLPurifier_Config object

---

validateChildren

Validates nodes according to definition and returns modification.

public validateChildren(array $children, \HTMLPurifier_Config $config, \HTMLPurifier_Context $context): array

Parameters:

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

---

__construct

public __construct(array|string $elements): mixed

Parameters:

Parameter	Type	Description
$elements	array|string	List of allowed element names (lowercase).

---

---

Automatically generated on 2025-03-18