wppaste
WordPress

WP_HTML_Stack_Event

Since
6.6.0
Source
wp-includes/html-api/class-wp-html-stack-event.php:22
Core class used by the HTML Processor as a record for stack operations.

Description

This class is for internal usage of the WP_HTML_Processor class.

Compatibility

WordPress
since 6.6.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 · 3

$tokenWP_HTML_Tokenpublic
References the token associated with the stack push event, even if this is a pop event for that element.
$operationstringpublic
Indicates which kind of stack operation this event represents.
$provenancestringpublic
Indicates if the stack element is a real or virtual node.

Methods · 1

Source code

class WP_HTML_Stack_Event {	/**	 * Refers to popping an element off of the stack of open elements.	 *	 * @since 6.6.0	 */	const POP = 'pop'; 	/**	 * Refers to pushing an element onto the stack of open elements.	 *	 * @since 6.6.0	 */	const PUSH = 'push'; 	/**	 * References the token associated with the stack push event,	 * even if this is a pop event for that element.	 *	 * @since 6.6.0	 *	 * @var WP_HTML_Token	 */	public $token; 	/**	 * Indicates which kind of stack operation this event represents.	 *	 * May be one of the class constants.	 *	 * @since 6.6.0	 *	 * @see self::POP	 * @see self::PUSH	 *	 * @var string	 */	public $operation; 	/**	 * Indicates if the stack element is a real or virtual node.	 *	 * @since 6.6.0	 *	 * @var string	 */	public $provenance; 	/**	 * Constructor function.	 *	 * @since 6.6.0	 *	 * @param WP_HTML_Token $token      Token associated with stack event, always an opening token.	 * @param string        $operation  One of self::PUSH or self::POP.	 * @param string        $provenance "virtual" or "real".	 */	public function __construct( WP_HTML_Token $token, string $operation, string $provenance ) {		$this->token      = $token;		$this->operation  = $operation;		$this->provenance = $provenance;	}}

Changelog

Introduced in 6.6.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 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-stack-event.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.