Changeset 6448 for sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php

Timestamp:

01/26/2018 11:08:46 PM (9 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Fix an upstream Parsedown bug that introduces unbalanced 'code' tags.

The bug still exists upstream and this "fix" merely seeks to undo the damage. Can be removed if/when Parsedown is fixed (but shouldn't pose a problem if it isn't).

Props pbiron.
See ​https://github.com/erusev/parsedown/pull/515.
Fixes #2900.

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php

@@ -34 +34 @@
                 add_filter( 'the_excerpt', array( __CLASS__, 'autolink_references' ), 11 );
                 add_filter( 'the_content', array( __CLASS__, 'autolink_references' ), 11 );
+
+                add_filter( 'devhub-parameter-type', array( __CLASS__, 'autolink_references' ) );
+
                 add_filter( 'devhub-format-description', array( __CLASS__, 'autolink_references' ) );
-                add_filter( 'devhub-parameter-type', array( __CLASS__, 'autolink_references' ) );
-
                 add_filter( 'devhub-format-description', array( __CLASS__, 'fix_param_hash_formatting' ), 9 );
+                add_filter( 'devhub-format-description', array( __CLASS__, 'fix_param_description_parsedown_bug' ) );
 
                 add_filter( 'devhub-function-return-type', array( __CLASS__, 'autolink_references' ) );
@@ -507 +509 @@
         }
 
+        /**
+         * Fix Parsedown bug that introduces unbalanced 'code' tags.
+         *
+         * Under very specific criteria, a bug in the Parsedown package used by the
+         * parser causes backtick-to-code-tag conversions to get mishandled, skipping
+         * conversion of a backtick and causing subsequent backticks to be converted
+         * incorrectly as an open or close 'code' tag (opposite of what it should've
+         * been). See referenced tickets for more details.
+         *
+         * Intended to be a temporary fix until/unless Parsedown is fixed.
+         *
+         * @see https://meta.trac.wordpress.org/ticket/2900
+         * @see https://github.com/erusev/parsedown/pull/515
+         */
+        public static function fix_param_description_parsedown_bug( $text ) {
+                $fixes = array(
+                        '/`(.+)<code>/'        => '<code>$1</code>',
+                        '/<\/code>(.+)`/'      => ' <code>$1</code>',
+                        '/<\/code>(.+)<code>/' => ' <code>$1</code>',
+                );
+
+                $matched = true;
+
+                foreach ( $fixes as $regex => $replace ) {
+                        if ( $matched && $matched = preg_match( $regex, $text, $match ) ) {
+                                $text = preg_replace( $regex, $replace, $text );
+                        }
+                }
+
+                return $text;
+        }
+
 } // DevHub_Formatting