Changeset 2206

Timestamp:

12/18/2015 06:15:42 PM (9 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Allow use of 'code' tags (generally added by parser through use of backticks in source) in parameter descriptions.

• Allow use of 'code' tags in parameter descriptions (by unencoding the tag).
• Consolidate parameter description formatting into DevHub_Formatting::format_param_description().

Location:

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

Files:

• formatting.php (modified) (1 diff)
• template-tags.php (modified) (1 diff)

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

@@ -195 +195 @@
     }
 
+    /**
+     * Handles formatting of the parameter description.
+     *
+     * @param  string $text The parameter description.
+     * @return string
+     */
+    public static function format_param_description( $text ) {
+        // Encode all htmlentities.
+        $text = htmlentities( $text );
+
+        // Simple allowable tags that should get unencoded.
+        // Note: This precludes them from being able to be used in an encoded fashion
+        // within a parameter description.
+        $allowable_tags = array( 'code' );
+        foreach ( $allowable_tags as $tag ) {
+            $text = str_replace( array( "&lt;{$tag}&gt;", "&lt;/{$tag}&gt;" ), array( "<{$tag}>", "</{$tag}>" ), $text );
+        }
+
+        // Convert any @link or @see to actual link.
+        $text = self::make_doclink_clickable( $text );
+
+        return $text;
+    }
+
 } // DevHub_Formatting
 

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

@@ -633 +633 @@
                         $params[ $tag['variable'] ]['required'] = 'Required';
                     }
-                    $params[ $tag['variable'] ]['content'] = htmlentities( $params[ $tag['variable'] ]['content'] );
-                    $params[ $tag['variable'] ]['content'] = \DevHub_Formatting::make_doclink_clickable( $params[ $tag['variable'] ]['content'] );
+                    $params[ $tag['variable'] ]['content'] = \DevHub_Formatting::format_param_description( $params[ $tag['variable'] ]['content'] );
                 }
             }