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

See #49572.

git-svn-id: https://develop.svn.wordpress.org/trunk@48175 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-06-26 09:28:21 +00:00
parent 37214834c3
commit 97bb45fe22
2 changed files with 9 additions and 9 deletions

View File

@ -2947,13 +2947,13 @@ function get_current_theme() {
* Accepts matches array from preg_replace_callback in wpautop() or a string. * Accepts matches array from preg_replace_callback in wpautop() or a string.
* *
* Ensures that the contents of a `<pre>...</pre>` HTML block are not * Ensures that the contents of a `<pre>...</pre>` HTML block are not
* converted into paragraphs or line-breaks. * converted into paragraphs or line breaks.
* *
* @since 1.2.0 * @since 1.2.0
* @deprecated 3.4.0 * @deprecated 3.4.0
* *
* @param array|string $matches The array or string * @param array|string $matches The array or string
* @return string The pre block without paragraph/line-break conversion. * @return string The pre block without paragraph/line break conversion.
*/ */
function clean_pre($matches) { function clean_pre($matches) {
_deprecated_function( __FUNCTION__, '3.4.0' ); _deprecated_function( __FUNCTION__, '3.4.0' );

View File

@ -425,16 +425,16 @@ function _wptexturize_pushpop_element( $text, &$stack, $disabled_elements ) {
} }
/** /**
* Replaces double line-breaks with paragraph elements. * Replaces double line breaks with paragraph elements.
* *
* A group of regex replaces used to identify text formatted with newlines and * A group of regex replaces used to identify text formatted with newlines and
* replace double line-breaks with HTML paragraph tags. The remaining line-breaks * replace double line breaks with HTML paragraph tags. The remaining line breaks
* after conversion become <<br />> tags, unless $br is set to '0' or 'false'. * after conversion become <<br />> tags, unless $br is set to '0' or 'false'.
* *
* @since 0.71 * @since 0.71
* *
* @param string $pee The text which has to be formatted. * @param string $pee The text which has to be formatted.
* @param bool $br Optional. If set, this will convert all remaining line-breaks * @param bool $br Optional. If set, this will convert all remaining line breaks
* after paragraphing. Line breaks within `<script>`, `<style>`, * after paragraphing. Line breaks within `<script>`, `<style>`,
* and `<svg>` tags are not affected. Default true. * and `<svg>` tags are not affected. Default true.
* @return string Text which has been converted into correct paragraph tags. * @return string Text which has been converted into correct paragraph tags.
@ -927,8 +927,8 @@ function seems_utf8( $str ) {
* converting single quotes if set to 'single', * converting single quotes if set to 'single',
* double if set to 'double' or both if otherwise set. * double if set to 'double' or both if otherwise set.
* Default is ENT_NOQUOTES. * Default is ENT_NOQUOTES.
* @param false|string $charset Optional. The character encoding of the string. Default is false. * @param false|string $charset Optional. The character encoding of the string. Default false.
* @param bool $double_encode Optional. Whether to encode existing html entities. Default is false. * @param bool $double_encode Optional. Whether to encode existing html entities. Default false.
* @return string The encoded text with HTML entities. * @return string The encoded text with HTML entities.
*/ */
function _wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) { function _wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
@ -1091,7 +1091,7 @@ function wp_specialchars_decode( $string, $quote_style = ENT_NOQUOTES ) {
* @since 2.8.0 * @since 2.8.0
* *
* @param string $string The text which is to be checked. * @param string $string The text which is to be checked.
* @param bool $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false. * @param bool $strip Optional. Whether to attempt to strip out invalid UTF8. Default false.
* @return string The checked text. * @return string The checked text.
*/ */
function wp_check_invalid_utf8( $string, $strip = false ) { function wp_check_invalid_utf8( $string, $strip = false ) {
@ -3789,7 +3789,7 @@ function human_time_diff( $from, $to = 0 ) {
* @since 5.2.0 Added the `$post` parameter. * @since 5.2.0 Added the `$post` parameter.
* *
* @param string $text Optional. The excerpt. If set to empty, an excerpt is generated. * @param string $text Optional. The excerpt. If set to empty, an excerpt is generated.
* @param WP_Post|object|int $post Optional. WP_Post instance or Post ID/object. Default is null. * @param WP_Post|object|int $post Optional. WP_Post instance or Post ID/object. Default null.
* @return string The excerpt. * @return string The excerpt.
*/ */
function wp_trim_excerpt( $text = '', $post = null ) { function wp_trim_excerpt( $text = '', $post = null ) {