WordPress.org
Get WordPress

Make WordPress Core

Changeset 53053


Ignore:
Timestamp:
04/02/2022 01:53:06 PM (3 years ago)
Author:
SergeyBiryukov
Message:

Docs: Further remove HTML markup from various function summaries.

Per the ​WordPress PHP documentation standards, no HTML markup or Markdown of any kind should be used in the summary. This ensures that the summary is displayed correctly in the ​WordPress Code Reference.

This commit also improves formatting of HTML special characters in descriptions in wp-includes/formatting.php.

Follow-up to [53048].

Props johnbillion, mukesh27.
Fixes #55506.

Location:
trunk/src/wp-includes
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/embed.php

    r52437 r53053  
    329329
    330330/**
    331  * Adds oEmbed discovery links in the website <head>.
     331 * Adds oEmbed discovery links in the head element of the website.
    332332 *
    333333 * @since 4.4.0

  • trunk/src/wp-includes/formatting.php

    r52821 r53053  
    375375 * and pops on tag close.
    376376 *
    377  * Assumes first char of $text is tag opening and last char is tag closing.
    378  * Assumes second char of $text is optionally '/' to indicate closing as in </html>.
     377 * Assumes first char of `$text` is tag opening and last char is tag closing.
     378 * Assumes second char of `$text` is optionally `/` to indicate closing as in `</html>`.
    379379 *
    380380 * @since 2.9.0
    … …  
    430430 * A group of regex replaces used to identify text formatted with newlines and
    431431 * replace double line breaks with HTML paragraph tags. The remaining line breaks
    432  * after conversion become <<br />> tags, unless $br is set to '0' or 'false'.
     432 * after conversion become `<br />` tags, unless `$br` is set to '0' or 'false'.
    433433 *
    434434 * @since 0.71
    … …  
    910910 * Converts a number of special characters into their HTML entities.
    911911 *
    912  * Specifically deals with: &, <, >, ", and '.
    913  *
    914  * $quote_style can be set to ENT_COMPAT to encode " to
    915  * &quot;, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
     912 * Specifically deals with: `&`, `<`, `>`, `"`, and `'`.
     913 *
     914 * `$quote_style` can be set to ENT_COMPAT to encode `"` to
     915 * `&quot;`, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
    916916 *
    917917 * @since 1.2.2
    … …  
    995995 * Converts a number of HTML entities into their special characters.
    996996 *
    997  * Specifically deals with: &, <, >, ", and '.
    998  *
    999  * $quote_style can be set to ENT_COMPAT to decode " entities,
    1000  * or ENT_QUOTES to do both " and '. Default is ENT_NOQUOTES where no quotes are decoded.
     997 * Specifically deals with: `&`, `<`, `>`, `"`, and `'`.
     998 *
     999 * `$quote_style` can be set to ENT_COMPAT to decode `"` entities,
     1000 * or ENT_QUOTES to do both `"` and `'`. Default is ENT_NOQUOTES where no quotes are decoded.
    10011001 *
    10021002 * @since 2.8.0
    … …  
    45114511
    45124512/**
    4513  * Escapes single quotes, htmlspecialchar " < > &, and fixes line endings.
     4513 * Escapes single quotes, `"`, `<`, `>`, `&`, and fixes line endings.
    45144514 *
    45154515 * Escapes text strings for echoing in JS. It is intended to be used for inline JS
    4516  * (in a tag attribute, for example onclick="..."). Note that the strings have to
     4516 * (in a tag attribute, for example `onclick="..."`). Note that the strings have to
    45174517 * be in single quotes. The {@see 'js_escape'} filter is also applied here.
    45184518 *

  • trunk/src/wp-includes/functions.wp-scripts.php

    r51726 r53053  
    167167 *                                    number is automatically added equal to current installed WordPress version.
    168168 *                                    If set to null, no version is added.
    169  * @param bool             $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
     169 * @param bool             $in_footer Optional. Whether to enqueue the script before `</body>` instead of in the `<head>`.
    170170 *                                    Default 'false'.
    171171 * @return bool Whether the script has been registered. True on success, false on failure.
    … …  
    341341 *                                    number is automatically added equal to current installed WordPress version.
    342342 *                                    If set to null, no version is added.
    343  * @param bool             $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
     343 * @param bool             $in_footer Optional. Whether to enqueue the script before `</body>` instead of in the `<head>`.
    344344 *                                    Default 'false'.
    345345 */

  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php

    r53048 r53053  
    483483
    484484    /**
    485      * Retrieves the head tag section.
     485     * Retrieves the head element section.
    486486     *
    487487     * @since 5.9.0

  • trunk/src/wp-includes/theme.php

    r52940 r53053  
    19491949
    19501950    /**
    1951      * Filters the Custom CSS Output into the <head>.
     1951     * Filters the custom CSS output into the head element.
    19521952     *
    19531953     * @since 4.7.0
Note: See TracChangeset for help on using the changeset viewer.