WP_HTML_Token
- Since
- 6.4.0
- Source
wp-includes/html-api/class-wp-html-token.php:22
Core class used by the HTML processor during HTML parsing for referring to tokens in the input HTML string.
Description
This class is designed for internal use by the HTML processor.
Compatibility
- WordPress
- since 6.4.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Properties · 6
$bookmark_namestring|nullpublic- Name of bookmark corresponding to source of token in input HTML string.
$node_namestringpublic- Name of node; lowercase names such as "marker" are not HTML elements.
$has_self_closing_flagboolpublic- Whether node contains the self-closing flag.
$namespacestringpublic- Indicates if the element is an HTML element or if it's inside foreign content.
$integration_node_typestring|nullpublic- Indicates which kind of integration point the element is, if any.
$on_destroycallable|nullpublic- Called when token is garbage-collected or otherwise destroyed.
Methods · 3
- __construct()Constructor - creates a reference to a token in some external HTML string.
- __destruct()Destructor.
- __wakeup()Wakeup magic method.
Source code
class WP_HTML_Token { /** * Name of bookmark corresponding to source of token in input HTML string. * * Having a bookmark name does not imply that the token still exists. It * may be that the source token and underlying bookmark was wiped out by * some modification to the source HTML. * * @since 6.4.0 * * @var string|null */ public $bookmark_name = null; /** * Name of node; lowercase names such as "marker" are not HTML elements. * * For HTML elements/tags this value should come from WP_HTML_Processor::get_tag(). * * @since 6.4.0 * * @see WP_HTML_Processor::get_tag() * * @var string */ public $node_name = null; /** * Whether node contains the self-closing flag. * * A node may have a self-closing flag when it shouldn't. This value * only reports if the flag is present in the original HTML. * * @since 6.4.0 * * @see https://html.spec.whatwg.org/#self-closing-flag * * @var bool */ public $has_self_closing_flag = false; /** * Indicates if the element is an HTML element or if it's inside foreign content. * * @since 6.7.0 * * @var string 'html', 'svg', or 'math'. */ public $namespace = 'html'; /** * Indicates which kind of integration point the element is, if any. * * @since 6.7.0 * * @var string|null 'math', 'html', or null if not an integration point. */ public $integration_node_type = null; /** * Called when token is garbage-collected or otherwise destroyed. * * @var callable|null */ public $on_destroy = null; /** * Constructor - creates a reference to a token in some external HTML string. * * @since 6.4.0 * * @param string|null $bookmark_name Name of bookmark corresponding to location in HTML where token is found, * or `null` for markers and nodes without a bookmark. * @param string $node_name Name of node token represents; if uppercase, an HTML element; if lowercase, a special value like "marker". * @param bool $has_self_closing_flag Whether the source token contains the self-closing flag, regardless of whether it's valid. * @param callable|null $on_destroy Optional. Function to call when destroying token, useful for releasing the bookmark. */ public function __construct( ?string $bookmark_name, string $node_name, bool $has_self_closing_flag, ?callable $on_destroy = null ) { $this->bookmark_name = $bookmark_name; $this->namespace = 'html';Changelog
Introduced in 6.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/html-api/class-wp-html-token.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.