Changeset 59765

Timestamp:

02/05/2025 11:51:28 PM (7 weeks ago)

Author:

SergeyBiryukov

Message:

Docs: Update comments in wp-includes/formatting.php per the documentation standards.

Follow-up to [1345], [8662], [8786], [33624], [34761].

Props kapasias, ankitkumarshah, swissspidy, peterwilsoncc.
Fixes #62885.

File:

• trunk/src/wp-includes/formatting.php (modified) (8 diffs)

trunk/src/wp-includes/formatting.php

@@ -575 +575 @@
         $text = preg_replace_callback( '/<(script|style|svg|math).*?<\/\\1>/s', '_autop_newline_preservation_helper', $text );
 
-        // Normalize <br>
+        // Normalize <br>.
         $text = str_replace( array( '<br>', '<br/>' ), '<br />', $text );
 
@@ -622 +622 @@
  * @since 4.4.0
  *
- * @return string The regular expression
+ * @return string The regular expression.
  */
 function get_html_split_regex() {
@@ -682 +682 @@
  *
  * @param string $shortcode_regex Optional. The result from _get_wptexturize_shortcode_regex().
- * @return string The regular expression
+ * @return string The regular expression.
  */
 function _get_wptexturize_split_regex( $shortcode_regex = '' ) {
@@ -724 +724 @@
  *
  * @param string[] $tagnames Array of shortcodes to find.
- * @return string The regular expression
+ * @return string The regular expression.
  */
 function _get_wptexturize_shortcode_regex( $tagnames ) {
@@ -878 +878 @@
  * @since 1.2.1
  *
- * @param string $str The string to be checked
+ * @param string $str The string to be checked.
  * @return bool True if $str fits a UTF-8 model, false otherwise.
  */
@@ -905 +905 @@
         }
 
-        for ( $j = 0; $j < $n; $j++ ) { // n bytes matching 10bbbbbb follow ?
+        for ( $j = 0; $j < $n; $j++ ) { // n bytes matching 10bbbbbb follow?
             if ( ( ++$i === $length ) || ( ( ord( $str[ $i ] ) & 0xC0 ) !== 0x80 ) ) {
                 return false;
@@ -1140 +1140 @@
  *
  * @param string $utf8_string             String to encode.
- * @param int    $length                  Max length of the string
+ * @param int    $length                  Max length of the string.
  * @param bool   $encode_ascii_characters Whether to encode ascii characters such as < " '
  * @return string String with Unicode encoded for URI.
@@ -2537 +2537 @@
  * @since 0.71
  *
- * @param string $text  Text to be balanced
+ * @param string $text  Text to be balanced.
  * @param bool   $force If true, forces balancing, ignoring the value of the option. Default false.
- * @return string Balanced text
+ * @return string Balanced text.
  */
 function balanceTags( $text, $force = false ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid