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

Timestamp:

01/29/2016 07:41:18 PM (9 years ago)

Author:

drewapicture

Message:

DevHub: Introduce DevHub_Formatting::link_internal_element(), which splits out logic from DevHub_Formatting::make_doclink_clickable() to make it reusable elsewhere.

The new link_internal_element() method serves to generate link markup for internal elements including properties, classes and methods, standalone functions, and hooks.

See #1498.

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

@@ -133 +133 @@
                 // Link to an internal resource.
                 else {
-
-                    // Link to class variable: {@see WP_Rewrite::$index}
-                    if ( false !== strpos( $link, '::$' ) ) {
-                        // Nothing to link to currently.
-                    }
-
-                    // Link to class method: {@see WP_Query::query()}
-                    elseif ( false !== strpos( $link, '::' ) ) {
-                        $link = '<a href="' .
-                            get_post_type_archive_link( 'wp-parser-class' ) .
-                            str_replace( array( '::', '()' ), array( '/', '' ), $link ) .
-                            '">' . esc_html( $link ) . '</a>';
-                    }
-
-                    // Link to hook: {@see 'pre_get_search_form'}
-                    elseif ( 1 === preg_match( '/^(&#8216;)\w+(&#8217;)$/', $link, $hook ) ) {
-                        if ( ! empty( $hook[0] ) ) {
-                            $link = '<a href="' .
-                                get_post_type_archive_link( 'wp-parser-hook' ) .
-                                str_replace( array( '&#8216;', '&#8217;' ), '', $link ) .
-                                '">' . esc_html( $link ) . '</a>';
-                        }
-                    }
-
-                    // Link to function: {@see esc_attr()}
-                    else {
-                        $link = '<a href="' .
-                            get_post_type_archive_link( 'wp-parser-function' ) .
-                            str_replace( '()', '', $link ) .
-                            '">' . esc_html( $link ) . '</a>';
-                    }
-
+                    $link = self::link_internal_element( $link );
                 }
 
@@ -171 +140 @@
             $content
         );
+    }
+
+    /**
+     * Parses and links an internal element if a valid element is found.
+     *
+     * @static
+     * @access public
+     *
+     * @param string $link Element string.
+     * @param string HTML link markup if a valid element was found.
+     */
+    public static function link_internal_element( $link ) {
+        // Link to class variable: {@see WP_Rewrite::$index}
+        if ( false !== strpos( $link, '::$' ) ) {
+            // Nothing to link to currently.
+        }
+
+        // Link to class method: {@see WP_Query::query()}
+        elseif ( false !== strpos( $link, '::' ) ) {
+            $link = '<a href="' .
+                    get_post_type_archive_link( 'wp-parser-class' ) .
+                    str_replace( array( '::', '()' ), array( '/', '' ), $link ) .
+                    '">' . esc_html( $link ) . '</a>';
+        }
+
+        // Link to hook: {@see 'pre_get_search_form'}
+        elseif ( 1 === preg_match( '/^(&#8216;)\w+(&#8217;)$/', $link, $hook ) ) {
+            if ( ! empty( $hook[0] ) ) {
+                $link = '<a href="' .
+                        get_post_type_archive_link( 'wp-parser-hook' ) .
+                        str_replace( array( '&#8216;', '&#8217;' ), '', $link ) .
+                        '">' . esc_html( $link ) . '</a>';
+            }
+        }
+
+        // Link to function: {@see esc_attr()}
+        else {
+            $link = '<a href="' .
+                    get_post_type_archive_link( 'wp-parser-function' ) .
+                    str_replace( '()', '', $link ) .
+                    '">' . esc_html( $link ) . '</a>';
+        }
+        return $link;
     }