class WP_HTML_Span {}

In this article

Core class used by the HTML tag processor to represent a textual span inside an HTML document.

Description

This is a two-tuple in disguise, used to avoid the memory overhead involved in using an array for the same purpose.

This class is for internal usage of the WP_HTML_Tag_Processor class.

See also

Methods

NameDescription
WP_HTML_Span::__constructConstructor.

Source

class WP_HTML_Span {
	/**
	 * Byte offset into document where span begins.
	 *
	 * @since 6.2.0
	 *
	 * @var int
	 */
	public $start;

	/**
	 * Byte length of this span.
	 *
	 * @since 6.5.0
	 *
	 * @var int
	 */
	public $length;

	/**
	 * Constructor.
	 *
	 * @since 6.2.0
	 *
	 * @param int $start  Byte offset into document where replacement span begins.
	 * @param int $length Byte length of span.
	 */
	public function __construct( int $start, int $length ) {
		$this->start  = $start;
		$this->length = $length;
	}
}

Changelog

VersionDescription
6.5.0Replaced end with length to more closely align with substr().
6.2.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.