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

Timestamp:

07/06/2016 07:16:58 PM (7 years ago)

Author:

drewapicture

Message:

developer.wordpress.org: Restructure reference pages to leverage a table of contents for the majority of the page output.

• Splits large sections of content-reference.php into individual template parts captured via output buffering.
• Introduces four top-level sections for any given reference page: Description, More Information (if an explanation exists), Related, and User Contributed Notes
• Improves overall responsive styling for smaller viewports

See #1802.

File:

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

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

@@ -550 +550 @@
             $delimiter = false !== strpos( $signature, '$' ) ? '"' : "'";
             $signature = $delimiter . $signature . $delimiter;
-            $signature = '<span class="hook-func">' . $hook_type . '</span> ( ' . $signature;
+            $signature = '<span class="hook-func">' . $hook_type . '</span>( ' . $signature;
             if ( $hook_args ) {
                 $signature .= ', ';
@@ -580 +580 @@
         }
 
-        $signature .= ' (';
+        $signature .= '(';
         if ( $args = implode( ', ', $args_strings ) ) {
             $signature .= $args . '&nbsp;';
@@ -1321 +1321 @@
         $post_field = get_post_field( $field, $explanation, $context );
 
-        // If retrieving the explanation content for display, add the TOC if available.
-        if ( 'post_content' === $field && 'display' === $context ) {
-            if ( class_exists( 'WPorg_Handbook_TOC' ) ) :
-                $TOC = new \WPorg_Handbook_TOC( get_parsed_post_types() );
-
-                add_filter( 'the_content', array( $TOC, 'add_toc' ) );
-                $post_field = apply_filters( 'the_content', apply_filters( 'get_the_content', $post_field ) );
-                remove_filter( 'the_content', array( $TOC, 'add_toc' ) );
-            else :
-                $post_field = apply_filters( 'the_content', apply_filters( 'get_the_content', $post_field ) );
-            endif;
-        }
-
-        return $post_field;
+        return apply_filters( 'the_content', apply_filters( 'get_the_content', $post_field ) );
     }
 
@@ -1440 +1427 @@
         echo $form;
     }
+
+    /**
+     * Retrieves all content for reference template parts.
+     *
+     * @return string Template part markup retrieved via output buffering.
+     */
+    function get_reference_template_parts() {
+        // Order dictates order of display.
+        $templates = array(
+            'description',
+            'params',
+            'return',
+            'source',
+            'changelog',
+            'explanation',
+            'related',
+            'methods',
+            'notes'
+        );
+
+        ob_start();
+
+        foreach ( $templates as $part ) {
+            get_template_part( 'reference/template', $part );
+        }
+
+        return ob_get_clean();
+    }
 }
-