Changeset 1045

Timestamp:

12/16/2014 08:15:00 PM (10 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: move formatting-related code into dedicated include file

Location:

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

Files:

• functions.php (modified) (3 diffs)
• inc/formatting.php (added)
• inc/template-tags.php (modified) (1 diff)

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

@@ -55 +55 @@
  */
 require __DIR__ . '/inc/redirects.php';
+
+/**
+ * Content formatting.
+ */
+require __DIR__ . '/inc/formatting.php';
 
 /**
@@ -80 +85 @@
     add_theme_support( 'automatic-feed-links' );
     add_theme_support( 'post-thumbnails' );
-
-    add_filter( 'the_excerpt', __NAMESPACE__ . '\\lowercase_P_dangit_just_once' );
-    add_filter( 'the_content', __NAMESPACE__ . '\\make_doclink_clickable', 10, 5 );
 
     // Add the handbook's 'Watch' action link.
@@ -422 +424 @@
     wp_enqueue_script( 'wporg-developer-search', get_template_directory_uri() . '/js/search.js', array(), '20141029', true );
 }
-
-/**
- * Allows for "Wordpress" just for the excerpt value of the capital_P_dangit function.
- *
- * WP.org has a global output buffer that runs capital_P_dangit() over displayed
- * content. For this one field of this one post, circumvent that function to
- * to show the lowercase P.
- *
- * @param  string $excerpt The post excerpt.
- * @return string
- */
-function lowercase_P_dangit_just_once( $excerpt ) {
-    if ( 'wp-parser-function' == get_post_type() && 'capital_P_dangit' == get_the_title() ) {
-        $excerpt = str_replace( 'Wordpress', 'Wordpress', $excerpt );
-    }
-
-    return $excerpt;
-}
-
-/**
- * Makes phpDoc @link references clickable.
- *
- * Handles these five different types of links:
- *
- * - {@link http://en.wikipedia.org/wiki/ISO_8601}
- * - {@link WP_Rewrite::$index}
- * - {@link WP_Query::query()}
- * - {@link esc_attr()}
- * - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
- *
- * @param  string $content The content.
- * @return string
- */
-function make_doclink_clickable( $content ) {
-
-    // Nothing to change unless a @link or @see reference is in the text.
-    if ( false === strpos( $content, '{@link ' ) && false === strpos( $content, '{@see ' ) ) {
-        return $content;
-    }
-
-    return preg_replace_callback(
-        '/\{@(?:link|see) ([^\}]+)\}/',
-        function ( $matches ) {
-
-            $link = $matches[1];
-
-            // Undo links made clickable during initial parsing
-            if ( 0 === strpos( $link, '<a ' ) ) {
-
-                if ( preg_match( '/^<a .*href=[\'\"]([^\'\"]+)[\'\"]>(.*)<\/a>(.*)$/', $link, $parts ) ) {
-                    $link = $parts[1];
-                    if ( $parts[3] ) {
-                        $link .= ' ' . $parts[3];
-                    }
-                }
-
-            }
-
-            // Link to an external resource.
-            if ( 0 === strpos( $link, 'http' ) ) {
-
-                $parts = explode( ' ', $link, 2 );
-
-                // 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>';
-                }
-
-                // 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>';
-                }
-
-            }
-
-            // Link to an internal resource.
-            else {
-
-                // Link to class variable: {@link WP_Rewrite::$index}
-                if ( false !== strpos( $link, '::$' ) ) {
-                    // Nothing to link to currently.
-                }
-
-                // Link to class method: {@link 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: {@link esc_attr()}
-                else {
-                    $link = '<a href="' .
-                        get_post_type_archive_link( 'wp-parser-function' ) .
-                        str_replace( '()', '', $link ) .
-                        '">' . esc_html( $link ) . '</a>';
-                }
-
-            }
-
-            return $link;
-        },
-        $content
-    );
-}

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

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