summaryrefslogtreecommitdiffstats
path: root/wp-includes/html-api/class-wp-html-attribute-token.php
diff options
context:
space:
mode:
Diffstat (limited to 'wp-includes/html-api/class-wp-html-attribute-token.php')
-rw-r--r--wp-includes/html-api/class-wp-html-attribute-token.php38
1 files changed, 32 insertions, 6 deletions
diff --git a/wp-includes/html-api/class-wp-html-attribute-token.php b/wp-includes/html-api/class-wp-html-attribute-token.php
index f938609..74d4132 100644
--- a/wp-includes/html-api/class-wp-html-attribute-token.php
+++ b/wp-includes/html-api/class-wp-html-attribute-token.php
@@ -15,6 +15,7 @@
*
* @access private
* @since 6.2.0
+ * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
*
* @see WP_HTML_Tag_Processor
*/
@@ -23,6 +24,7 @@ class WP_HTML_Attribute_Token {
* Attribute name.
*
* @since 6.2.0
+ *
* @var string
*/
public $name;
@@ -31,6 +33,7 @@ class WP_HTML_Attribute_Token {
* Attribute value.
*
* @since 6.2.0
+ *
* @var int
*/
public $value_starts_at;
@@ -39,6 +42,7 @@ class WP_HTML_Attribute_Token {
* How many bytes the value occupies in the input HTML.
*
* @since 6.2.0
+ *
* @var int
*/
public $value_length;
@@ -47,22 +51,43 @@ class WP_HTML_Attribute_Token {
* The string offset where the attribute name starts.
*
* @since 6.2.0
+ *
* @var int
*/
public $start;
/**
- * The string offset after the attribute value or its name.
+ * Byte length of text spanning the attribute inside a tag.
+ *
+ * This span starts at the first character of the attribute name
+ * and it ends after one of three cases:
+ *
+ * - at the end of the attribute name for boolean attributes.
+ * - at the end of the value for unquoted attributes.
+ * - at the final single or double quote for quoted attributes.
+ *
+ * Example:
+ *
+ * <div class="post">
+ * ------------ length is 12, including quotes
+ *
+ * <input type="checked" checked id="selector">
+ * ------- length is 6
+ *
+ * <a rel=noopener>
+ * ------------ length is 11
+ *
+ * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
*
- * @since 6.2.0
* @var int
*/
- public $end;
+ public $length;
/**
* Whether the attribute is a boolean attribute with value `true`.
*
* @since 6.2.0
+ *
* @var bool
*/
public $is_true;
@@ -71,20 +96,21 @@ class WP_HTML_Attribute_Token {
* Constructor.
*
* @since 6.2.0
+ * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
*
* @param string $name Attribute name.
* @param int $value_start Attribute value.
* @param int $value_length Number of bytes attribute value spans.
* @param int $start The string offset where the attribute name starts.
- * @param int $end The string offset after the attribute value or its name.
+ * @param int $length Byte length of the entire attribute name or name and value pair expression.
* @param bool $is_true Whether the attribute is a boolean attribute with true value.
*/
- public function __construct( $name, $value_start, $value_length, $start, $end, $is_true ) {
+ public function __construct( $name, $value_start, $value_length, $start, $length, $is_true ) {
$this->name = $name;
$this->value_starts_at = $value_start;
$this->value_length = $value_length;
$this->start = $start;
- $this->end = $end;
+ $this->length = $length;
$this->is_true = $is_true;
}
}