Changeset 35005 for trunk/src/wp-admin/includes/template-functions.php

Timestamp:

10/10/2015 06:42:19 AM (11 years ago)

Author:

SergeyBiryukov

Message:

Add echo parameter for wp_star_rating().

See #34080.

File:

• trunk/src/wp-admin/includes/template-functions.php (modified) (4 diffs)

trunk/src/wp-admin/includes/template-functions.php

@@ -1985 +1985 @@
  *
  * @since 3.8.0
+ * @since 4.4.0 Introduced the `echo` parameter.
+ *
  * @param array $args {
  *     Optional. Array of star ratings arguments.
@@ -1993 +1995 @@
  *                          or, 'percent'. Default 'rating'.
  *     @type int    $number The number of ratings that makes up this rating. Default 0.
+ *     @type bool   $echo   Whether to echo the generated markup. False to return the markup instead
+ *                          of echoing it. Default true.
  * }
  */
@@ -1998 +2002 @@
         $defaults = array(
                 'rating' => 0,
-                'type' => 'rating',
+                'type'   => 'rating',
                 'number' => 0,
+                'echo'   => true,
         );
         $r = wp_parse_args( $args, $defaults );
@@ -2025 +2030 @@
         }
 
-        echo '<div class="star-rating" title="' . esc_attr( $title ) . '">';
-        echo '<span class="screen-reader-text">' . $title . '</span>';
-        echo str_repeat( '<div class="star star-full"></div>', $full_stars );
-        echo str_repeat( '<div class="star star-half"></div>', $half_stars );
-        echo str_repeat( '<div class="star star-empty"></div>', $empty_stars);
-        echo '</div>';
+        $output = '<div class="star-rating" title="' . esc_attr( $title ) . '">';
+        $output .= '<span class="screen-reader-text">' . $title . '</span>';
+        $output .= str_repeat( '<div class="star star-full"></div>', $full_stars );
+        $output .= str_repeat( '<div class="star star-half"></div>', $half_stars );
+        $output .= str_repeat( '<div class="star star-empty"></div>', $empty_stars );
+        $output .= '</div>';
+
+        if ( $r['echo'] ) {
+                echo $output;
+        }
+
+        return $output;
 }