Changeset 7769

Timestamp:

10/24/2018 09:41:00 PM (8 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Centralize creation of doclink link markup into new generate_link().

Also adds 'devhub-format-link-attributes' filter for adding/editing attributes used for a link.

Props pbiron.
Fixes #3649.

File:

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

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

@@ -134 +134 @@
                                         // Link without linked text: {@link http://en.wikipedia.org/wiki/ISO_8601}
                                         if ( 1 === count( $parts ) ) {
-                                                $link = '<a href="' . esc_url( $link ) . '">' . esc_html( $link ) . '</a>';
+                                                $url = $text = $link;
                                         }
 
                                         // Link with linked text: {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
                                         else {
-                                                $link = '<a href="' . esc_url( $parts[0] ) . '">' . esc_html( $parts[1] ) . '</a>';
+                                                $url = $parts[0];
+                                                $text = $parts[1];
                                         }
 
+                                        $link = self::generate_link( $url, $text );
                                 }
 
@@ -165 +167 @@
          */
         public static function link_internal_element( $link ) {
+                $url = '';
+
                 // Link to class variable: {@see WP_Rewrite::$index}
                 if ( false !== strpos( $link, '::$' ) ) {
@@ -172 +176 @@
                 // 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>';
+                        $url = get_post_type_archive_link( 'wp-parser-class' ) .
+                                str_replace( array( '::', '()' ), array( '/', '' ), $link );
                 }
 
@@ -181 +183 @@
                 elseif ( 1 === preg_match( '/^(?:\'|(?:&#8216;))([\$\w-&;]+)(?:\'|(?:&#8217;))$/', $link, $hook ) ) {
                         if ( ! empty( $hook[1] ) ) {
-                                $link = '<a href="' .
-                                        get_post_type_archive_link( 'wp-parser-hook' ) .
-                                        sanitize_title_with_dashes( html_entity_decode( $hook[1] ) ) . '/' .
-                                        '">' . esc_html( $link ) . '</a>';
+                                $url = get_post_type_archive_link( 'wp-parser-hook' ) .
+                                        sanitize_title_with_dashes( html_entity_decode( $hook[1] ) ) . '/';
                         }
                 }
@@ -197 +197 @@
                         ( 1 === preg_match ( '/^_?[A-Z][a-zA-Z]+_\w+/', $link ) ) // Otherwise, class names start with (optional underscore, then) uppercase and have underscore
                 ) {
-                        $link = sprintf(
-                                '<a href="%s">%s</a>',
-                                esc_url( get_post_type_archive_link( 'wp-parser-class' ) . sanitize_key( $link ) ),
-                                esc_html( $link )
-                        );
+                        $url = get_post_type_archive_link( 'wp-parser-class' ) . sanitize_key( $link );
                 }
 
                 // Link to function: {@see esc_attr()}
                 else {
-                        $link = '<a href="' .
-                                        get_post_type_archive_link( 'wp-parser-function' ) .
-                                        sanitize_title_with_dashes( html_entity_decode( $link ) ) .
-                                        '">' . esc_html( $link ) . '</a>';
+                        $url = get_post_type_archive_link( 'wp-parser-function' ) .
+                                        sanitize_title_with_dashes( html_entity_decode( $link ) );
+                }
+                
+                if ( $url ) {
+                        $link = self::generate_link( $url, $link );
                 }
                 return $link;
         }
 
+        /**
+         * Generates a link given a URL and text.
+         *
+         * @param string $url  The URL, for the link's href attribute.
+         * @param string $text The text content of the link.
+         * @return string The HTML for the link.
+         */
+        public static function generate_link( $url, $text ) {
+                /**
+                 * Filters the HTML attributes applied to a link's anchor element.
+                 *
+                 * @param array  $attrs The HTML attributes applied to the link's anchor element.
+                 * @param string $url   The URL for the link.
+                 */
+                $attrs = (array) apply_filters( 'devhub-format-link-attributes', array( 'href' => $url ), $url );
+
+                // Make sure the filter didn't completely remove the href attribute.
+                if ( empty( $attrs['href'] ) ) {
+                        $attrs['href'] = $url;
+                }
+
+                $attributes = '';
+                foreach ( $attrs as $name => $value ) {
+                        $value = 'href' === $name ? esc_url( $value ) : esc_attr( $value );
+                        $attributes .= sprintf( ' %s="%s"', esc_attr( $name ), $value );
+                }
+
+                return sprintf( '<a%s>%s</a>', $attributes, esc_html( $text ) );
+        }
+        
         /**
          * Fixes unintended markup generated by Markdown during parsing.