Changeset 52789

Timestamp:

02/23/2022 08:01:55 PM (2 years ago)

Author:

hellofromTonya

Message:

Formatting: Make terms in wpautop() and shortcode_unautop() more welcoming and inclusive.

The developer facing humor in these functions were from a different era of WordPress. Tolerance for in-jokes and other developer facing humor has decreased over the years. Terms like "pee" and "tinkle" may make some folks chuckle while for others it makes them uncomfortable.

Terminology of the past is being (or has been) re-evaluated to transform words into a language that are inclusive and welcome for all. This commit is part of that effort as it replaces.

Follow-up [13], [9255].

Props ricomoorman, tzipporahwitty, ironprogrammer, peterwilsoncc, jeremyfelt, Viper007Bond, rmccue, SergeyBiryukov, hellofromTonya.
Fixes #25615.

Location:

trunk

Files:

• src/wp-includes/formatting.php (modified) (6 diffs)
• tests/phpunit/tests/formatting/wpAutop.php (modified) (2 diffs)

trunk/src/wp-includes/formatting.php

@@ -434 +434 @@
  * @since 0.71
  *
- * @param string $pee The text which has to be formatted.
- * @param bool   $br  Optional. If set, this will convert all remaining line breaks
- *                    after paragraphing. Line breaks within `<script>`, `<style>`,
- *                    and `<svg>` tags are not affected. Default true.
+ * @param string $ The text which has to be formatted.
+ * @param bool   $br  Optional. If set, this will convert all remaining line breaks
+ *                    after paragraphing. Line breaks within `<script>`, `<style>`,
+ *                    and `<svg>` tags are not affected. Default true.
  * @return string Text which has been converted into correct paragraph tags.
  */
-function wpautop( $pee, $br = true ) {
+function wpautop( $, $br = true ) {
     $pre_tags = array();
 
-    if ( trim( $pee ) === '' ) {
+    if ( trim( $ ) === '' ) {
         return '';
     }
 
     // Just to make things a little easier, pad the end.
-    $pee = $pee . "\n";
+    $ . "\n";
 
     /*
@@ -454 +454 @@
      * Replace pre tags with placeholders and bring them back after autop.
      */
-    if ( strpos( $pee, '<pre' ) !== false ) {
-        $pee_parts = explode( '</pre>', $pee );
-        $last_pee  = array_pop( $pee_parts );
-        $pee       = '';
-        $i         = 0;
-
-        foreach ( $pee_parts as $pee_part ) {
-            $start = strpos( $pee_part, '<pre' );
+    if ( strpos( $, '<pre' ) !== false ) {
+        $ );
+        $last_p_parts );
+        $       = '';
+        $i         = 0;
+
+        foreach ( $_part ) {
+            $start = strpos( $_part, '<pre' );
 
             // Malformed HTML?
             if ( false === $start ) {
-                $pee .= $pee_part;
+                $_part;
                 continue;
             }
 
             $name              = "<pre wp-pre-tag-$i></pre>";
-            $pre_tags[ $name ] = substr( $pee_part, $start ) . '</pre>';
-
-            $pee .= substr( $pee_part, 0, $start ) . $name;
+            $pre_tags[ $name ] = substr( $_part, $start ) . '</pre>';
+
+            $_part, 0, $start ) . $name;
             $i++;
         }
 
-        $pee .= $last_pee;
+        $;
     }
     // Change multiple <br>'s into two line breaks, which will turn into paragraphs.
-    $pee = preg_replace( '|<br\s*/?>\s*<br\s*/?>|', "\n\n", $pee );
+    $ );
 
     $allblocks = '(?:table|thead|tfoot|caption|col|colgroup|tbody|tr|td|th|div|dl|dd|dt|ul|ol|li|pre|form|map|area|blockquote|address|math|style|p|h[1-6]|hr|fieldset|legend|section|article|aside|hgroup|header|footer|nav|figure|figcaption|details|menu|summary)';
 
     // Add a double line break above block-level opening tags.
-    $pee = preg_replace( '!(<' . $allblocks . '[\s/>])!', "\n\n$1", $pee );
+    $ );
 
     // Add a double line break below block-level closing tags.
-    $pee = preg_replace( '!(</' . $allblocks . '>)!', "$1\n\n", $pee );
+    $ );
 
     // Add a double line break after hr tags, which are self closing.
-    $pee = preg_replace( '!(<hr\s*?/?>)!', "$1\n\n", $pee );
+    $ );
 
     // Standardize newline characters to "\n".
-    $pee = str_replace( array( "\r\n", "\r" ), "\n", $pee );
+    $ );
 
     // Find newlines in all elements and add placeholders.
-    $pee = wp_replace_in_html_tags( $pee, array( "\n" => ' <!-- wpnl --> ' ) );
+    $, array( "\n" => ' <!-- wpnl --> ' ) );
 
     // Collapse line breaks before and after <option> elements so they don't get autop'd.
-    if ( strpos( $pee, '<option' ) !== false ) {
-        $pee = preg_replace( '|\s*<option|', '<option', $pee );
-        $pee = preg_replace( '|</option>\s*|', '</option>', $pee );
+    if ( strpos( $, '<option' ) !== false ) {
+        $ );
+        $ );
     }
 
@@ -508 +508 @@
      * so they don't get autop'd.
      */
-    if ( strpos( $pee, '</object>' ) !== false ) {
-        $pee = preg_replace( '|(<object[^>]*>)\s*|', '$1', $pee );
-        $pee = preg_replace( '|\s*</object>|', '</object>', $pee );
-        $pee = preg_replace( '%\s*(</?(?:param|embed)[^>]*>)\s*%', '$1', $pee );
+    if ( strpos( $, '</object>' ) !== false ) {
+        $ );
+        $ );
+        $ );
     }
 
@@ -518 +518 @@
      * before and after <source> and <track> elements.
      */
-    if ( strpos( $pee, '<source' ) !== false || strpos( $pee, '<track' ) !== false ) {
-        $pee = preg_replace( '%([<\[](?:audio|video)[^>\]]*[>\]])\s*%', '$1', $pee );
-        $pee = preg_replace( '%\s*([<\[]/(?:audio|video)[>\]])%', '$1', $pee );
-        $pee = preg_replace( '%\s*(<(?:source|track)[^>]*>)\s*%', '$1', $pee );
+    if ( strpos( $, '<track' ) !== false ) {
+        $ );
+        $ );
+        $ );
     }
 
     // Collapse line breaks before and after <figcaption> elements.
-    if ( strpos( $pee, '<figcaption' ) !== false ) {
-        $pee = preg_replace( '|\s*(<figcaption[^>]*>)|', '$1', $pee );
-        $pee = preg_replace( '|</figcaption>\s*|', '</figcaption>', $pee );
+    if ( strpos( $, '<figcaption' ) !== false ) {
+        $ );
+        $ );
     }
 
     // Remove more than two contiguous line breaks.
-    $pee = preg_replace( "/\n\n+/", "\n\n", $pee );
+    $ );
 
     // Split up the contents into an array of strings, separated by double line breaks.
-    $pees = preg_split( '/\n\s*\n/', $pee, -1, PREG_SPLIT_NO_EMPTY );
-
-    // Reset $pee prior to rebuilding.
-    $pee = '';
+    $p, -1, PREG_SPLIT_NO_EMPTY );
+
+    // Reset $ prior to rebuilding.
+    $ = '';
 
     // Rebuild the content as a string, wrapping every bit with a <p>.
-    foreach ( $pees as $tinkle ) {
-        $pee .= '<p>' . trim( $tinkle, "\n" ) . "</p>\n";
+    foreach ( $p ) {
+        $, "\n" ) . "</p>\n";
     }
 
     // Under certain strange conditions it could create a P of entirely whitespace.
-    $pee = preg_replace( '|<p>\s*</p>|', '', $pee );
+    $ );
 
     // Add a closing <p> inside <div>, <address>, or <form> tag if missing.
-    $pee = preg_replace( '!<p>([^<]+)</(div|address|form)>!', '<p>$1</p></$2>', $pee );
+    $ );
 
     // If an opening or closing block element tag is wrapped in a <p>, unwrap it.
-    $pee = preg_replace( '!<p>\s*(</?' . $allblocks . '[^>]*>)\s*</p>!', '$1', $pee );
+    $ );
 
     // In some cases <li> may get wrapped in <p>, fix them.
-    $pee = preg_replace( '|<p>(<li.+?)</p>|', '$1', $pee );
+    $ );
 
     // If a <blockquote> is wrapped with a <p>, move it inside the <blockquote>.
-    $pee = preg_replace( '|<p><blockquote([^>]*)>|i', '<blockquote$1><p>', $pee );
-    $pee = str_replace( '</blockquote></p>', '</p></blockquote>', $pee );
+    $ );
+    $ );
 
     // If an opening or closing block element tag is preceded by an opening <p> tag, remove it.
-    $pee = preg_replace( '!<p>\s*(</?' . $allblocks . '[^>]*>)!', '$1', $pee );
+    $ );
 
     // If an opening or closing block element tag is followed by a closing <p> tag, remove it.
-    $pee = preg_replace( '!(</?' . $allblocks . '[^>]*>)\s*</p>!', '$1', $pee );
+    $ );
 
     // Optionally insert line breaks.
     if ( $br ) {
         // Replace newlines that shouldn't be touched with a placeholder.
-        $pee = preg_replace_callback( '/<(script|style|svg).*?<\/\\1>/s', '_autop_newline_preservation_helper', $pee );
+        $ );
 
         // Normalize <br>
-        $pee = str_replace( array( '<br>', '<br/>' ), '<br />', $pee );
+        $ );
 
         // Replace any new line characters that aren't preceded by a <br /> with a <br />.
-        $pee = preg_replace( '|(?<!<br />)\s*\n|', "<br />\n", $pee );
+        $ );
 
         // Replace newline placeholders with newlines.
-        $pee = str_replace( '<WPPreserveNewline />', "\n", $pee );
+        $ );
     }
 
     // If a <br /> tag is after an opening or closing block tag, remove it.
-    $pee = preg_replace( '!(</?' . $allblocks . '[^>]*>)\s*<br />!', '$1', $pee );
+    $ );
 
     // If a <br /> tag is before a subset of opening or closing block tags, remove it.
-    $pee = preg_replace( '!<br />(\s*</?(?:p|li|div|dl|dd|dt|th|pre|td|ul|ol)[^>]*>)!', '$1', $pee );
-    $pee = preg_replace( "|\n</p>$|", '</p>', $pee );
+    $ );
+    $ );
 
     // Replace placeholder <pre> tags with their original content.
     if ( ! empty( $pre_tags ) ) {
-        $pee = str_replace( array_keys( $pre_tags ), array_values( $pre_tags ), $pee );
+        $ );
     }
 
     // Restore newlines in all elements.
-    if ( false !== strpos( $pee, '<!-- wpnl -->' ) ) {
-        $pee = str_replace( array( ' <!-- wpnl --> ', '<!-- wpnl -->' ), "\n", $pee );
-    }
-
-    return $pee;
+    if ( false !== strpos( $, '<!-- wpnl -->' ) ) {
+        $ );
+    }
+
+    return $;
 }
 
@@ -815 +815 @@
  * @global array $shortcode_tags
  *
- * @param string $pee The content.
+ * @param string $ The content.
  * @return string The filtered content.
  */
-function shortcode_unautop( $pee ) {
+function shortcode_unautop( $ ) {
     global $shortcode_tags;
 
     if ( empty( $shortcode_tags ) || ! is_array( $shortcode_tags ) ) {
-        return $pee;
+        return $;
     }
 
@@ -862 +862 @@
     // phpcs:enable
 
-    return preg_replace( $pattern, '$1', $pee );
+    return preg_replace( $pattern, '$1', $ );
 }
 

trunk/tests/phpunit/tests/formatting/wpAutop.php

@@ -532 +532 @@
      * @ticket 4857
      */
-    public function test_that_text_before_blocks_is_peed() {
+    public function test_that_text_before_blocks_is_() {
         $content  = 'a<div>b</div>';
         $expected = "<p>a</p>\n<div>b</div>";
@@ -566 +566 @@
      * @ticket 14674
      */
-    public function test_the_hr_is_not_peed() {
+    public function test_the_hr_is_not_() {
         $content  = 'paragraph1<hr>paragraph2';
         $expected = "<p>paragraph1</p>\n<hr>\n<p>paragraph2</p>";