Changeset 48199 for trunk/src/wp-includes/general-template.php

Timestamp:

06/28/2020 02:00:26 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Replace "html" and "xhtml" instances in DocBlocks and comments with "HTML" and "XHTML".

This ensures consistent capitalization where appropriate.

Props navidos, desrosj.
Fixes #50473.

File:

• trunk/src/wp-includes/general-template.php (modified) (16 diffs)

trunk/src/wp-includes/general-template.php

@@ -3916 +3916 @@
  *
  * The search query string is passed through esc_attr() to ensure that it is safe
- * for placing in an html attribute.
+ * for placing in an HTML attribute.
  *
  * @since 2.3.0
@@ -3944 +3944 @@
  *
  * The search query string is passed through esc_attr() to ensure that it is safe
- * for placing in an html attribute.
+ * for placing in an HTML attribute.
  *
  * @since 2.1.0
@@ -3960 +3960 @@
 
 /**
- * Gets the language attributes for the html tag.
- *
- * Builds up a set of html attributes containing the text direction and language
+ * Gets the language attributes for the 'html' tag.
+ *
+ * Builds up a set of HTML attributes containing the text direction and language
  * information for the page.
  *
  * @since 4.3.0
  *
- * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.
+ * @param string $doctype Optional. The type of HTML document. Accepts 'xhtml' or 'html'. Default 'html'.
  */
 function get_language_attributes( $doctype = 'html' ) {
@@ -3990 +3990 @@
 
     /**
-     * Filters the language attributes for display in the html tag.
+     * Filters the language attributes for display in the 'html' tag.
      *
      * @since 2.5.0
@@ -3996 +3996 @@
      *
      * @param string $output A space-separated list of language attributes.
-     * @param string $doctype The type of html document (xhtml|html).
+     * @param string $doctype The type of HTML document (xhtml|html).
      */
     return apply_filters( 'language_attributes', $output, $doctype );
@@ -4002 +4002 @@
 
 /**
- * Displays the language attributes for the html tag.
- *
- * Builds up a set of html attributes containing the text direction and language
+ * Displays the language attributes for the 'html' tag.
+ *
+ * Builds up a set of HTML attributes containing the text direction and language
  * information for the page.
  *
@@ -4010 +4010 @@
  * @since 4.3.0 Converted into a wrapper for get_language_attributes().
  *
- * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.
+ * @param string $doctype Optional. The type of HTML document. Accepts 'xhtml' or 'html'. Default 'html'.
  */
 function language_attributes( $doctype = 'html' ) {
@@ -4655 +4655 @@
 
 /**
- * Outputs the html checked attribute.
+ * Outputs the HTML checked attribute.
  *
  * Compares the first two arguments and if identical marks as checked
@@ -4664 +4664 @@
  * @param mixed $current (true) The other value to compare if not just true
  * @param bool  $echo    Whether to echo or just return the string
- * @return string html attribute or empty string
+ * @return string HTML attribute or empty string
  */
 function checked( $checked, $current = true, $echo = true ) {
@@ -4671 +4671 @@
 
 /**
- * Outputs the html selected attribute.
+ * Outputs the HTML selected attribute.
  *
  * Compares the first two arguments and if identical marks as selected
@@ -4680 +4680 @@
  * @param mixed $current  (true) The other value to compare if not just true
  * @param bool  $echo     Whether to echo or just return the string
- * @return string html attribute or empty string
+ * @return string HTML attribute or empty string
  */
 function selected( $selected, $current = true, $echo = true ) {
@@ -4687 +4687 @@
 
 /**
- * Outputs the html disabled attribute.
+ * Outputs the HTML disabled attribute.
  *
  * Compares the first two arguments and if identical marks as disabled
@@ -4696 +4696 @@
  * @param mixed $current  (true) The other value to compare if not just true
  * @param bool  $echo     Whether to echo or just return the string
- * @return string html attribute or empty string
+ * @return string HTML attribute or empty string
  */
 function disabled( $disabled, $current = true, $echo = true ) {
@@ -4703 +4703 @@
 
 /**
- * Outputs the html readonly attribute.
+ * Outputs the HTML readonly attribute.
  *
  * Compares the first two arguments and if identical marks as readonly
@@ -4712 +4712 @@
  * @param mixed $current  (true) The other value to compare if not just true
  * @param bool  $echo     Whether to echo or just return the string
- * @return string html attribute or empty string
+ * @return string HTML attribute or empty string
  */
 function readonly( $readonly, $current = true, $echo = true ) {
@@ -4730 +4730 @@
  * @param bool   $echo    Whether to echo or just return the string
  * @param string $type    The type of checked|selected|disabled|readonly we are doing
- * @return string html attribute or empty string
+ * @return string HTML attribute or empty string
  */
 function __checked_selected_helper( $helper, $current, $echo, $type ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore