Context Navigation

formatting.php

Timestamp:

12/18/2015 06:15:42 PM (11 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().

File:

-              r1914
+              r2206
+        }
+        /**
+         * 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

Note: See TracChangeset for help on using the changeset viewer.