Changeset 6682

Timestamp:

09/09/2017 04:49:42 AM (4 years ago)

Author:

johnjamesjacoby

Message:

Template: adjust escaping of pagination count strings.

This change fixes a regression (in trunk only) that caused the filtered results of pagination counts to always be late escaped, but the intention was really only to escape the output of _n() which does not have an escaped equivalent function in the Gettext API.

I also tweaked the logic in bbp_get_topic_pagination_count() to not bail early. This brings it inline with bbp_get_forum_pagination_count() and allows the filter to run even when the text string is empty. Flexibility is the goal, so skipping the filter was also unintentional, and is now fixed.

Fixes #3162.

Location:

trunk/src/includes

Files:

• replies/template.php (modified) (4 diffs)
• topics/template.php (modified) (2 diffs)

trunk/src/includes/replies/template.php

@@ -2238 +2238 @@
  * Output the topic pagination count
  *
+ * The results are unescaped by design, to allow them to be filtered freely via
+ * the 'bbp_get_topic_pagination_count' filter.
+ *
  * @since 2.0.0 bbPress (r2519)
  *
  */
 function bbp_topic_pagination_count() {
-    echo esc_html( bbp_get_topic_pagination_count() );
+    echo bbp_get_topic_pagination_count();
 }
     /**
@@ -2258 +2261 @@
 
         // Set pagination values
+        $count_int = intval( $bbp->reply_query->post_count     );
         $total_int = intval( $bbp->reply_query->found_posts    );
         $ppp_int   = intval( $bbp->reply_query->posts_per_page );
         $start_int = intval( ( $bbp->reply_query->paged - 1 ) * $ppp_int ) + 1;
         $to_int    = intval( ( $start_int + ( $ppp_int - 1 ) > $total_int )
-                ? $total_int
-                : $start_int + ( $ppp_int - 1 ) );
+            ? $total_int
+            : $start_int + ( $ppp_int - 1 ) );
 
         // Format numbers for display
+        $count_num = bbp_number_format( $count_int );
         $total_num = bbp_number_format( $total_int );
         $from_num  = bbp_number_format( $start_int );
@@ -2285 +2290 @@
             // Several replies in a topic with several pages
             } else {
-                $retstr = sprintf( _n( 'Viewing %2$s replies (of %4$s total)', 'Viewing %1$s replies - %2$s through %3$s (of %4$s total)', $bbp->reply_query->post_count, 'bbpress' ), $bbp->reply_query->post_count, $from_num, $to_num, $total_num );
+                $retstr = sprintf( _n( 'Viewing %2$s replies (of %4$s total)', 'Viewing %1$s replies - %2$s through %3$s (of %4$s total)', $count_int, 'bbpress' ), $count_num, $from_num, $to_num, $total_num );
             }
 
@@ -2297 +2302 @@
             // Several posts in a topic with several pages
             } else {
-                $retstr = sprintf( _n( 'Viewing %2$s post (of %4$s total)', 'Viewing %1$s posts - %2$s through %3$s (of %4$s total)', $bbp->reply_query->post_count, 'bbpress' ), $bbp->reply_query->post_count, $from_num, $to_num, $total_num );
+                $retstr = sprintf( _n( 'Viewing %2$s post (of %4$s total)', 'Viewing %1$s posts - %2$s through %3$s (of %4$s total)', $count_int, 'bbpress' ), $count_num, $from_num, $to_num, $total_num );
             }
         }
+
+        // Escape results of _n()
+        $retstr = esc_html( $retstr );
 
         // Filter & return

trunk/src/includes/topics/template.php

@@ -2917 +2917 @@
  * Output the pagination count
  *
+ * The results are unescaped by design, to allow them to be filtered freely via
+ * the 'bbp_get_forum_pagination_count' filter.
+ *
  * @since 2.0.0 bbPress (r2519)
  */
 function bbp_forum_pagination_count() {
-    echo esc_html( bbp_get_forum_pagination_count() );
+    echo bbp_get_forum_pagination_count();
 }
     /**
@@ -2932 +2935 @@
         $bbp = bbpress();
 
-        if ( empty( $bbp->topic_query ) ) {
-            return false;
-        }
-
-        // Set pagination values
-        $start_num = intval( ( $bbp->topic_query->paged - 1 ) * $bbp->topic_query->posts_per_page ) + 1;
-        $from_num  = bbp_number_format( $start_num );
-        $to_num    = bbp_number_format( ( $start_num + ( $bbp->topic_query->posts_per_page - 1 ) > $bbp->topic_query->found_posts ) ? $bbp->topic_query->found_posts : $start_num + ( $bbp->topic_query->posts_per_page - 1 ) );
-        $total_int = (int) ! empty( $bbp->topic_query->found_posts ) ? $bbp->topic_query->found_posts : $bbp->topic_query->post_count;
-        $total     = bbp_number_format( $total_int );
-
-        // Several topics in a forum with a single page
-        if ( empty( $to_num ) ) {
-            $retstr = sprintf( _n( 'Viewing %1$s topic', 'Viewing %1$s topics', $total_int, 'bbpress' ), $total );
-
-        // Several topics in a forum with several pages
-        } else {
-            $retstr = sprintf( _n( 'Viewing topic %2$s (of %4$s total)', 'Viewing %1$s topics - %2$s through %3$s (of %4$s total)', $total_int, 'bbpress' ), $bbp->topic_query->post_count, $from_num, $to_num, $total );
+        // Define local variable(s)
+        $retstr = '';
+
+        // Topic query exists
+        if ( ! empty( $bbp->topic_query ) ) {
+
+            // Set pagination values
+            $count_int = intval( $bbp->topic_query->post_count );
+            $start_num = intval( ( $bbp->topic_query->paged - 1 ) * $bbp->topic_query->posts_per_page ) + 1;
+            $total_int = ! empty( $bbp->topic_query->found_posts )
+                ? (int) $bbp->topic_query->found_posts
+                : $count_int;
+
+            // Format numbers for display
+            $count_num = bbp_number_format( $count_int );
+            $from_num  = bbp_number_format( $start_num );
+            $total     = bbp_number_format( $total_int );
+            $to_num    = bbp_number_format( ( $start_num + ( $bbp->topic_query->posts_per_page - 1 ) > $bbp->topic_query->found_posts )
+                ? $bbp->topic_query->found_posts
+                : $start_num + ( $bbp->topic_query->posts_per_page - 1 ) );
+
+            // Several topics in a forum with a single page
+            if ( empty( $to_num ) ) {
+                $retstr = sprintf( _n( 'Viewing %1$s topic', 'Viewing %1$s topics', $total_int, 'bbpress' ), $total );
+
+            // Several topics in a forum with several pages
+            } else {
+                $retstr = sprintf( _n( 'Viewing topic %2$s (of %4$s total)', 'Viewing %1$s topics - %2$s through %3$s (of %4$s total)', $total_int, 'bbpress' ), $count_num, $from_num, $to_num, $total );
+            }
+
+            // Escape results of _n()
+            $retstr = esc_html( $retstr );
         }