Changeset 1062

Timestamp:

12/23/2014 06:49:40 PM (12 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Don't display "void" as a return value

Only display the return type if it is explicitly defined and it isn't "void". This rules out the display of return type for classes, hooks, and non-returning functions.

Location:

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

Files:

• content-reference.php (modified) (1 diff)
• inc/template-tags.php (modified) (2 diffs)

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

@@ -16 +16 @@
                 <?php echo get_long_description(); ?>
         </section>
-        <section class="return"><p><strong>Return:</strong> <?php echo get_return(); ?></p></section>
+
+        <?php
+        $return = get_return();
+        if ( ! empty( $return ) ) :
+                ?>
+                <section class="return"><p><strong><?php _e( 'Return:', 'wporg' ); ?></strong> <?php echo $return; ?></p></section>
+        <?php endif; ?>
 
         <?php

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

@@ -659 +659 @@
 
         /**
-         * Retrieve return type and description if available
+         * Retrieve return type and description if available.
+         *
+         * If there is no explicit return value, or it is explicitly "void", then
+         * an empty string is returned. This rules out display of return type for
+         * classes, hooks, and non-returning functions.
          *
          * @param int $post_id
@@ -674 +678 @@
                 $return = wp_filter_object_list( $tags, array( 'name' => 'return' ) );
 
+                // If there is no explicit or non-"void" return value, don't display one.
                 if ( empty( $return ) ) {
-                        $description = '';
-                        $type        = 'void';
-                } else {
-                        $return      = array_shift( $return );
-                        $description = empty( $return['content'] ) ? '' : esc_html( $return['content'] );
-                        $type        = empty( $return['types'] ) ? '' : esc_html( implode( '|', $return['types'] ) );
-                }
+                        return '';
+                }
+
+                $return      = array_shift( $return );
+                $description = empty( $return['content'] ) ? '' : esc_html( $return['content'] );
+                $type        = empty( $return['types'] ) ? '' : esc_html( implode( '|', $return['types'] ) );
 
                 return "<span class='return-type'>({$type})</span> $description";