Changeset 6383

Timestamp:

01/12/2018 09:37:09 PM (8 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Append heretofore unshown @see tags from docblocks to list at end of description.

Fixes #3165.

Location:

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

Files:

• inc/template-tags.php (modified) (1 diff)
• reference/template-description.php (modified) (1 diff)

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

@@ -1330 +1330 @@
 
     /**
+     * Gets list of additional resources linked via `@see` tags.
+     *
+     * @param  null|WP_Post Optional. The post.
+     * @return array
+     */
+    function get_see_tags( $post = null ) {
+        $post = get_post( $post );
+
+        $tags = get_post_meta( $post->ID, '_wp-parser_tags', true );
+
+        return wp_list_filter( $tags, array( 'name' => 'see' ) );
+    }
+
+    /**
      * Should the search bar be shown?
      *

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

@@ -14 +14 @@
     <h2><?php _e( 'Description', 'wporg' ); ?></h2>
     <?php echo get_description(); ?>
+
+    <?php if ( $see = get_see_tags() ) : ?>
+    <h3><?php _e( 'See also', 'wporg' ); ?></h3>
+
+    <ul>
+    <?php
+    foreach ( $see as $tag ) {
+        $see_ref = '';
+        if ( ! empty( $tag['refers'] ) ) {
+            $see_ref .= '{@see ' . $tag['refers'] . '}';
+        }
+        if ( ! empty( $tag['content'] ) ) {
+            if ( $see_ref ) {
+                $see_ref .= ': ';
+            }
+            $see_ref .= $tag['content'];
+        }
+        // Process text for auto-linking, etc.
+        remove_filter( 'the_content', 'wpautop' );
+        $see_ref = apply_filters( 'the_content', apply_filters( 'get_the_content', $see_ref ) );
+        add_filter( 'the_content', 'wpautop' );
+    
+        echo '<li>' . $see_ref . "</li>\n";
+    }
+    ?>
+    </ul>
+    <?php endif; ?>
 </section>