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

Timestamp:

11/14/2018 12:30:35 AM (8 years ago)

Author:

coffee2code

Message:

Developer: Wrap single-quoted HTML in parameter descriptions within 'code' tags.

Of course, HTML meant to be shown as HTML should have originally been wrapped in backticks instead of single-quotes, but fastidious adherence to documentation formatting standards isn't currently enforced.

See ​https://core.trac.wordpress.org/ticket/38721.
Fixes #3920.

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

@@ -40 +40 @@
                 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-format-description', array( __CLASS__, 'fix_param_description_html_as_code' ) );
 
                 add_filter( 'devhub-function-return-type', array( __CLASS__, 'autolink_references' ) );
@@ -569 +570 @@
         }
 
+        /**
+         * Wraps single-quoted HTML within 'code' tags.
+         *
+         * The HTML should have been denoted with backticks in the original source, in
+         * which case it would have been parsed properly, but committers aren't
+         * always sticklers for documentation formatting.
+         *
+         * @access public
+         *
+         * @param string $text Text.
+         * @return string
+         */
+        public static function fix_param_description_html_as_code( $text ) {
+                if ( false !== strpos( $text, "'<" ) ) {
+                        $text = preg_replace( '/\'(&lt;[^\']+&gt;)\'/', '<code>$1</code>', $text );
+                }
+
+                return $text;
+        }
+
 } // DevHub_Formatting