Changeset 6680 for trunk/src/includes/replies/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/replies/template.php (modified) (5 diffs)

trunk/src/includes/replies/template.php

@@ -172 +172 @@
 
         // Set posts_per_page value if replies are threaded
-        $replies_per_page = $r['posts_per_page'];
+        $replies_per_page = (int) $r['posts_per_page'];
         if ( true === $r['hierarchical'] ) {
                 $r['posts_per_page'] = -1;
@@ -184 +184 @@
 
         // Add pagination values to query object
-        $bbp->reply_query->posts_per_page = $replies_per_page;
-        $bbp->reply_query->paged          = $r['paged'];
+        $bbp->reply_query->posts_per_page = (int) $replies_per_page;
+        $bbp->reply_query->paged          = (int) $r['paged'];
 
         // Never home, regardless of what parse_query says
@@ -196 +196 @@
 
         // Only add reply to if query returned results
-        if ( (int) $bbp->reply_query->found_posts ) {
+        if ( ! empty( $bbp->reply_query->found_posts ) ) {
 
                 // Get reply to for each reply
@@ -217 +217 @@
 
         // Only add pagination if query returned results
-        if ( (int) $bbp->reply_query->found_posts && (int) $bbp->reply_query->posts_per_page ) {
-
-                // If pretty permalinks are enabled, make our pagination pretty
-                if ( bbp_use_pretty_urls() ) {
-
-                        // User's replies
-                        if ( bbp_is_single_user_replies() ) {
-                                $base = bbp_get_user_replies_created_url( bbp_get_displayed_user_id() );
-
-                        // Root profile page
-                        } elseif ( bbp_is_single_user() ) {
-                                $base = bbp_get_user_profile_url( bbp_get_displayed_user_id() );
-
-                        // Page or single post
-                        } elseif ( is_page() || is_single() ) {
-                                $base = get_permalink();
-
-                        // Single topic
-                        } else {
-                                $base = get_permalink( bbp_get_topic_id() );
-                        }
-
-                        $base = trailingslashit( $base ) . user_trailingslashit( bbp_get_paged_slug() . '/%#%/' );
-
-                // Unpretty permalinks
-                } else {
-                        $base = add_query_arg( 'paged', '%#%' );
-                }
+        if ( ! empty( $bbp->reply_query->found_posts ) && ! empty( $bbp->reply_query->posts_per_page ) ) {
 
                 // Figure out total pages
                 if ( true === $r['hierarchical'] ) {
                         $walker      = new BBP_Walker_Reply;
-                        $total_pages = ceil( (int) $walker->get_number_of_root_elements( $bbp->reply_query->posts ) / (int) $replies_per_page );
+                        $total_pages = ceil( $walker->get_number_of_root_elements( $bbp->reply_query->posts ) / $bbp->reply_query->posts_per_page );
                 } else {
-                        $total_pages = ceil( (int) $bbp->reply_query->found_posts / (int) $replies_per_page );
+
+                        // Total for pagination boundaries
+                        $total_pages = ( $bbp->reply_query->posts_per_page === $bbp->reply_query->found_posts )
+                                ? 1
+                                : ceil( $bbp->reply_query->found_posts / $bbp->reply_query->posts_per_page );
+
+                        // Pagination settings with filter
+                        $bbp_replies_pagination = apply_filters( 'bbp_replies_pagination', array(
+                                'base'    => bbp_get_replies_pagination_base( bbp_get_topic_id() ),
+                                'total'   => $total_pages,
+                                'current' => $bbp->reply_query->paged
+                        ) );
 
                         // Add pagination to query object
-                        $bbp->reply_query->pagination_links = paginate_links( apply_filters( 'bbp_replies_pagination', array(
-                                'base'      => $base,
-                                'format'    => '',
-                                'total'     => $total_pages,
-                                'current'   => (int) $bbp->reply_query->paged,
-                                'prev_text' => is_rtl() ? '→' : '←',
-                                'next_text' => is_rtl() ? '←' : '→',
-                                'mid_size'  => 1,
-                                'add_args'  => ( bbp_get_view_all() ) ? array( 'view' => 'all' ) : false
-                        ) ) );
-
-                        // Remove first page from pagination
-                        if ( bbp_use_pretty_urls() ) {
-                                $bbp->reply_query->pagination_links = str_replace( bbp_get_paged_slug() . '/1/', '', $bbp->reply_query->pagination_links );
-                        } else {
-                                $bbp->reply_query->pagination_links = preg_replace( '/&paged=1(?=[^0-9])/m', '', $bbp->reply_query->pagination_links );
-                        }
+                        $bbp->reply_query->pagination_links = bbp_paginate_links( $bbp_replies_pagination );
                 }
         }
@@ -2224 +2192 @@
         }
 
+/** Pagination ****************************************************************/
+
+/**
+ * Return the base URL used inside of pagination links
+ *
+ * @since 2.6.0 bbPress (r6679)
+ *
+ * @param int $topic_id
+ * @return string
+ */
+function bbp_get_replies_pagination_base( $topic_id = 0 ) {
+
+        // If pretty permalinks are enabled, make our pagination pretty
+        if ( bbp_use_pretty_urls() ) {
+
+                // User's replies
+                if ( bbp_is_single_user_replies() ) {
+                        $base = bbp_get_user_replies_created_url( bbp_get_displayed_user_id() );
+
+                // Root profile page
+                } elseif ( bbp_is_single_user() ) {
+                        $base = bbp_get_user_profile_url( bbp_get_displayed_user_id() );
+
+                // Page or single post
+                } elseif ( is_page() || is_single() ) {
+                        $base = get_permalink();
+
+                // Single topic
+                } else {
+                        $base = get_permalink( $topic_id );
+                }
+
+                $base = trailingslashit( $base ) . user_trailingslashit( bbp_get_paged_slug() . '/%#%/' );
+
+        // Unpretty permalinks
+        } else {
+                $base = add_query_arg( 'paged', '%#%' );
+        }
+
+        // Filter & return
+        return apply_filters( 'bbp_get_replies_pagination_base', $base, $topic_id );
+}
+
 /**
  * Output the topic pagination count