WordPress.org

Make WordPress Core


Ignore:
Timestamp:
06/28/2020 02:00:26 PM (17 months 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/general-template.php

    r48197 r48199  
    39163916 *
    39173917 * The search query string is passed through esc_attr() to ensure that it is safe
    3918  * for placing in an html attribute.
     3918 * for placing in an HTML attribute.
    39193919 *
    39203920 * @since 2.3.0
     
    39443944 *
    39453945 * The search query string is passed through esc_attr() to ensure that it is safe
    3946  * for placing in an html attribute.
     3946 * for placing in an HTML attribute.
    39473947 *
    39483948 * @since 2.1.0
     
    39603960
    39613961/**
    3962  * Gets the language attributes for the html tag.
    3963  *
    3964  * Builds up a set of html attributes containing the text direction and language
     3962 * Gets the language attributes for the 'html' tag.
     3963 *
     3964 * Builds up a set of HTML attributes containing the text direction and language
    39653965 * information for the page.
    39663966 *
    39673967 * @since 4.3.0
    39683968 *
    3969  * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.
     3969 * @param string $doctype Optional. The type of HTML document. Accepts 'xhtml' or 'html'. Default 'html'.
    39703970 */
    39713971function get_language_attributes( $doctype = 'html' ) {
     
    39903990
    39913991    /**
    3992      * Filters the language attributes for display in the html tag.
     3992     * Filters the language attributes for display in the 'html' tag.
    39933993     *
    39943994     * @since 2.5.0
     
    39963996     *
    39973997     * @param string $output A space-separated list of language attributes.
    3998      * @param string $doctype The type of html document (xhtml|html).
     3998     * @param string $doctype The type of HTML document (xhtml|html).
    39993999     */
    40004000    return apply_filters( 'language_attributes', $output, $doctype );
     
    40024002
    40034003/**
    4004  * Displays the language attributes for the html tag.
    4005  *
    4006  * Builds up a set of html attributes containing the text direction and language
     4004 * Displays the language attributes for the 'html' tag.
     4005 *
     4006 * Builds up a set of HTML attributes containing the text direction and language
    40074007 * information for the page.
    40084008 *
     
    40104010 * @since 4.3.0 Converted into a wrapper for get_language_attributes().
    40114011 *
    4012  * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.
     4012 * @param string $doctype Optional. The type of HTML document. Accepts 'xhtml' or 'html'. Default 'html'.
    40134013 */
    40144014function language_attributes( $doctype = 'html' ) {
     
    46554655
    46564656/**
    4657  * Outputs the html checked attribute.
     4657 * Outputs the HTML checked attribute.
    46584658 *
    46594659 * Compares the first two arguments and if identical marks as checked
     
    46644664 * @param mixed $current (true) The other value to compare if not just true
    46654665 * @param bool  $echo    Whether to echo or just return the string
    4666  * @return string html attribute or empty string
     4666 * @return string HTML attribute or empty string
    46674667 */
    46684668function checked( $checked, $current = true, $echo = true ) {
     
    46714671
    46724672/**
    4673  * Outputs the html selected attribute.
     4673 * Outputs the HTML selected attribute.
    46744674 *
    46754675 * Compares the first two arguments and if identical marks as selected
     
    46804680 * @param mixed $current  (true) The other value to compare if not just true
    46814681 * @param bool  $echo     Whether to echo or just return the string
    4682  * @return string html attribute or empty string
     4682 * @return string HTML attribute or empty string
    46834683 */
    46844684function selected( $selected, $current = true, $echo = true ) {
     
    46874687
    46884688/**
    4689  * Outputs the html disabled attribute.
     4689 * Outputs the HTML disabled attribute.
    46904690 *
    46914691 * Compares the first two arguments and if identical marks as disabled
     
    46964696 * @param mixed $current  (true) The other value to compare if not just true
    46974697 * @param bool  $echo     Whether to echo or just return the string
    4698  * @return string html attribute or empty string
     4698 * @return string HTML attribute or empty string
    46994699 */
    47004700function disabled( $disabled, $current = true, $echo = true ) {
     
    47034703
    47044704/**
    4705  * Outputs the html readonly attribute.
     4705 * Outputs the HTML readonly attribute.
    47064706 *
    47074707 * Compares the first two arguments and if identical marks as readonly
     
    47124712 * @param mixed $current  (true) The other value to compare if not just true
    47134713 * @param bool  $echo     Whether to echo or just return the string
    4714  * @return string html attribute or empty string
     4714 * @return string HTML attribute or empty string
    47154715 */
    47164716function readonly( $readonly, $current = true, $echo = true ) {
     
    47304730 * @param bool   $echo    Whether to echo or just return the string
    47314731 * @param string $type    The type of checked|selected|disabled|readonly we are doing
    4732  * @return string html attribute or empty string
     4732 * @return string HTML attribute or empty string
    47334733 */
    47344734function __checked_selected_helper( $helper, $current, $echo, $type ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
Note: See TracChangeset for help on using the changeset viewer.