Changeset 6680 for trunk/src/includes/topics/template.php

Timestamp:

09/07/2017 05:40:59 AM (9 years ago)

Author:

johnjamesjacoby

Message:

Pagination: abstract and normalize common functionality.

This change introduces a few new helper functions, and audits the links generated where loops of forums, topics, and replies are made visible. It addresses a number of edge-cases in the pagination code, including:

• view=all state not carrying over
• Total-page boundary maybe using the wrong value to calculate the total number of available pages
• Inconsistent output of values across post types and shortcodes
• Inability to filter pagination arguments in certain use cases
• Reduces code repetition and increases general happiness

Trunk, for 2.6.

File:

• trunk/src/includes/topics/template.php (modified) (8 diffs)

trunk/src/includes/topics/template.php

@@ -203 +203 @@
         // Limited the number of pages shown
         if ( ! empty( $r['max_num_pages'] ) ) {
-                $bbp->topic_query->max_num_pages = $r['max_num_pages'];
+                $bbp->topic_query->max_num_pages = (int) $r['max_num_pages'];
         }
 
@@ -223 +223 @@
 
         // Only add pagination if query returned results
-        if ( ( (int) $bbp->topic_query->post_count || (int) $bbp->topic_query->found_posts ) && (int) $bbp->topic_query->posts_per_page ) {
+        if ( ( ! empty( $bbp->topic_query->post_count ) || ! empty( $bbp->topic_query->found_posts ) ) && ! empty( $bbp->topic_query->posts_per_page ) ) {
 
                 // Limit the number of topics shown based on maximum allowed pages
@@ -231 +231 @@
 
                 // Total topics for pagination boundaries
-                $total = ( $r['posts_per_page'] === $bbp->topic_query->found_posts )
+                $total_pages = ( $bbp->topic_query->posts_per_page === $bbp->topic_query->found_posts )
                         ? 1
-                        : ceil( (int) $bbp->topic_query->found_posts / (int) $r['posts_per_page'] );
+                        : ceil( $bbp->topic_query->found_posts / $bbp->topic_query->posts_per_page );
+
+                // Maybe add view-all args
+                $add_args = bbp_get_view_all()
+                        ? array( 'view' => 'all' )
+                        : false;
 
                 // Pagination settings with filter
@@ -239 +244 @@
                         'base'      => bbp_get_topics_pagination_base( $r['post_parent'] ),
                         'format'    => '',
-                        'total'     => (int) $total,
-                        'current'   => (int) $bbp->topic_query->paged,
+                        'total'     => $total_pages,
+                        'current'   => $bbp->topic_query->paged,
                         'prev_text' => is_rtl() ? '→' : '←',
                         'next_text' => is_rtl() ? '←' : '→',
-                        'mid_size'  => 1
+                        'mid_size'  => 1,
+                        'add_args'  => $add_args,
                 ) );
 
                 // Add pagination to query object
-                $bbp->topic_query->pagination_links = paginate_links( $bbp_topic_pagination );
-
-                // Remove first page from pagination
-                $bbp->topic_query->pagination_links = str_replace( bbp_get_paged_slug() . "/1/'", "'", $bbp->topic_query->pagination_links );
+                $bbp->topic_query->pagination_links = bbp_paginate_links( $bbp_topic_pagination );
         }
 
@@ -781 +784 @@
 
                 // If pretty permalinks are enabled, make our pagination pretty
-                if ( bbp_use_pretty_urls() ) {
-                        $base = trailingslashit( get_permalink( $r['topic_id'] ) ) . user_trailingslashit( bbp_get_paged_slug() . '/%#%/' );
-                } else {
-                        $base = add_query_arg( 'paged', '%#%', get_permalink( $r['topic_id'] ) );
-                }
+                $base = bbp_use_pretty_urls()
+                        ? trailingslashit( get_permalink( $r['topic_id'] ) ) . user_trailingslashit( bbp_get_paged_slug() . '/%#%/' )
+                        : add_query_arg( 'paged', '%#%', get_permalink( $r['topic_id'] ) );
 
                 // Get total and add 1 if topic is included in the reply loop
@@ -794 +795 @@
                         $total++;
                 }
+
+                // Total for pagination boundaries
+                $total_pages = ceil( $total / bbp_get_replies_per_page() );
 
                 // Maybe add view-all args
@@ -800 +804 @@
                         : false;
 
-                // Add pagination to query object
-                $pagination_links = paginate_links( array(
+                // Pagination settings with filter
+                $bbp_topic_pagination = apply_filters( 'bbp_get_topic_pagination', array(
                         'base'      => $base,
-                        'format'    => '',
-                        'total'     => ceil( (int) $total / (int) bbp_get_replies_per_page() ),
+                        'total'     => $total_pages,
                         'current'   => 0,
                         'prev_next' => false,
                         'mid_size'  => 2,
-                        'end_size'  => 3,
+                        'end_size'  => 2,
                         'add_args'  => $add_args
                 ) );
 
+                // Add pagination to query object
+                $pagination_links = bbp_paginate_links( $bbp_topic_pagination );
+
+                // Maybe add before and after to pagination links
                 if ( ! empty( $pagination_links ) ) {
-
-                        // Remove first page from pagination
-                        if ( bbp_use_pretty_urls() ) {
-                                $pagination_links = str_replace( bbp_get_paged_slug() . '/1/', '', $pagination_links );
-                        } else {
-                                $pagination_links = preg_replace( '/&paged=1(?=[^0-9])/m', '', $pagination_links );
-                        }
-
-                        // Add before and after to pagination links
                         $pagination_links = $r['before'] . $pagination_links . $r['after'];
                 }
@@ -2913 +2911 @@
 
         // Filter & return
-        return apply_filters( 'bbp_get_topics_pagination_base', $base );
+        return apply_filters( 'bbp_get_topics_pagination_base', $base, $forum_id );
 }