Changeset 41184

Timestamp:

07/29/2017 08:34:26 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Plugins: In wp_star_rating(), use explicit type casting for $rating to avoid a "non-numeric value encountered" warning in PHP 7.1.

Clarify in the function DocBlock that $rating can be a float.

Props afragen.
Fixes #41484.

File:

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

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

@@ -2095 +2095 @@
  *     Optional. Array of star ratings arguments.
  *
- *     @type int    $rating The rating to display, expressed in either a 0.5 rating increment,
- *                          or percentage. Default 0.
- *     @type string $type   Format that the $rating is in. Valid values are 'rating' (default),
- *                          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.
+ *     @type int|float $rating The rating to display, expressed in either a 0.5 rating increment,
+ *                             or percentage. Default 0.
+ *     @type string    $type   Format that the $rating is in. Valid values are 'rating' (default),
+ *                             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.
  * }
+ * @return string Star rating HTML.
  */
 function wp_star_rating( $args = array() ) {
@@ -2113 +2114 @@
     $r = wp_parse_args( $args, $defaults );
 
-    // Non-english decimal places when the $rating is coming from a string
-    $rating = str_replace( ',', '.', $r['rating'] );
+    // Non-English decimal places when the $rating is coming from a string
+    $rating = (float) str_replace( ',', '.', $r['rating'] );
 
     // Convert Percentage to star rating, 0..5 in .5 increments
-    if ( 'percent' == $r['type'] ) {
+    if ( 'percent' === $r['type'] ) {
         $rating = round( $rating / 10, 0 ) / 2;
     }