Make WordPress Core


Ignore:
Timestamp:
06/26/2020 09:28:21 AM (4 years ago)
Author:
SergeyBiryukov
Message:

Docs: Spell "line breaks" in a consistent way.

See #49572.

File:
1 edited

Legend:

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

    r48174 r48175  
    426426
    427427/**
    428  * Replaces double line-breaks with paragraph elements.
     428 * Replaces double line breaks with paragraph elements.
    429429 *
    430430 * A group of regex replaces used to identify text formatted with newlines and
    431  * replace double line-breaks with HTML paragraph tags. The remaining line-breaks
     431 * replace double line breaks with HTML paragraph tags. The remaining line breaks
    432432 * after conversion become <<br />> tags, unless $br is set to '0' or 'false'.
    433433 *
     
    435435 *
    436436 * @param string $pee The text which has to be formatted.
    437  * @param bool   $br  Optional. If set, this will convert all remaining line-breaks
     437 * @param bool   $br  Optional. If set, this will convert all remaining line breaks
    438438 *                    after paragraphing. Line breaks within `<script>`, `<style>`,
    439439 *                    and `<svg>` tags are not affected. Default true.
     
    928928 *                                    double if set to 'double' or both if otherwise set.
    929929 *                                    Default is ENT_NOQUOTES.
    930  * @param false|string $charset       Optional. The character encoding of the string. Default is false.
    931  * @param bool         $double_encode Optional. Whether to encode existing html entities. Default is false.
     930 * @param false|string $charset       Optional. The character encoding of the string. Default false.
     931 * @param bool         $double_encode Optional. Whether to encode existing html entities. Default false.
    932932 * @return string The encoded text with HTML entities.
    933933 */
     
    10921092 *
    10931093 * @param string  $string The text which is to be checked.
    1094  * @param bool    $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false.
     1094 * @param bool    $strip  Optional. Whether to attempt to strip out invalid UTF8. Default false.
    10951095 * @return string The checked text.
    10961096 */
     
    37903790 *
    37913791 * @param string             $text Optional. The excerpt. If set to empty, an excerpt is generated.
    3792  * @param WP_Post|object|int $post Optional. WP_Post instance or Post ID/object. Default is null.
     3792 * @param WP_Post|object|int $post Optional. WP_Post instance or Post ID/object. Default null.
    37933793 * @return string The excerpt.
    37943794 */
Note: See TracChangeset for help on using the changeset viewer.