WP_HTML_Text_Replacement{}WP 6.2.0

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.

This class is for internal usage of the WP_HTML_Tag_Processor class.

Internal function — this function is designed to be used by the kernel itself. It is not recommended to use this function in your code.

No Hooks.

Usage

$WP_HTML_Text_Replacement = new WP_HTML_Text_Replacement();
// use class methods

Methods

  1. public __construct( int $start, int $length, string $text )

Notes

Changelog

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

WP_HTML_Text_Replacement{} code WP 6.7.1

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( int $start, int $length, string $text ) {
		$this->start  = $start;
		$this->length = $length;
		$this->text   = $text;
	}
}