class WP_HTML_Text_Replacement {}

In this article

Core class used by the HTML tag processor as a data structure for replacing existing content from start to end, allowing to drastically improve performance.

Description

This class is for internal usage of the WP_HTML_Tag_Processor class.

See also

Methods

NameDescription
WP_HTML_Text_Replacement::__constructConstructor.

Source

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

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

	/**
	 * Span of text to insert in document to replace existing content from start to end.
	 *
	 * @since 6.2.0
	 *
	 * @var string
	 */
	public $text;

	/**
	 * Constructor.
	 *
	 * @since 6.2.0
	 *
	 * @param int    $start  Byte offset into document where replacement span begins.
	 * @param int    $length Byte length of span in document being replaced.
	 * @param string $text   Span of text to insert in document to replace existing content from start to end.
	 */
	public function __construct( $start, $length, $text ) {
		$this->start  = $start;
		$this->length = $length;
		$this->text   = $text;
	}
}

Changelog

VersionDescription
6.5.0Replace end with length to more closely match substr().
6.2.0Introduced.

User Contributed Notes

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