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

trunk/src/includes/search/template.php

@@ -77 +77 @@
 
         // Add pagination values to query object
-        $bbp->search_query->posts_per_page = $r['posts_per_page'];
-        $bbp->search_query->paged          = $r['paged'];
+        $bbp->search_query->posts_per_page = (int) $r['posts_per_page'];
+        $bbp->search_query->paged          = (int) $r['paged'];
 
         // Never home, regardless of what parse_query says
@@ -86 +86 @@
         if ( ! empty( $bbp->search_query->found_posts ) && ! empty( $bbp->search_query->posts_per_page ) ) {
 
-                // Array of arguments to add after pagination links
-                $add_args = array();
-
-                // If pretty permalinks are enabled, make our pagination pretty
-                if ( bbp_use_pretty_urls() ) {
-
-                        // Shortcode territory
-                        if ( is_page() || is_single() ) {
-                                $base = trailingslashit( get_permalink() );
-
-                        // Default search location
-                        } else {
-                                $base = trailingslashit( bbp_get_search_results_url() );
-                        }
-
-                        // Add pagination base
-                        $base = $base . user_trailingslashit( bbp_get_paged_slug() . '/%#%/' );
-
-                // Unpretty permalinks
-                } else {
-                        $base = add_query_arg( 'paged', '%#%' );
-                }
-
-                // Add args
-                if ( bbp_get_view_all() ) {
-                        $add_args['view'] = 'all';
-                }
+                // Total for pagination boundaries
+                $total_pages = ( $bbp->search_query->posts_per_page === $bbp->search_query->found_posts )
+                        ? 1
+                        : ceil( $bbp->search_query->found_posts / $bbp->search_query->posts_per_page );
+
+                // Pagination settings with filter
+                $bbp_search_pagination = apply_filters( 'bbp_search_results_pagination', array(
+                        'base'    => bbp_get_search_pagination_base(),
+                        'total'   => $total_pages,
+                        'current' => $bbp->search_query->paged
+                ) );
 
                 // Add pagination to query object
-                $bbp->search_query->pagination_links = paginate_links(
-                        apply_filters( 'bbp_search_results_pagination', array(
-                                'base'      => $base,
-                                'format'    => '',
-                                'total'     => ceil( (int) $bbp->search_query->found_posts / (int) $r['posts_per_page'] ),
-                                'current'   => (int) $bbp->search_query->paged,
-                                'prev_text' => is_rtl() ? '→' : '←',
-                                'next_text' => is_rtl() ? '←' : '→',
-                                'mid_size'  => 1,
-                                'add_args'  => $add_args,
-                        ) )
-                );
-
-                // Remove first page from pagination
-                if ( bbp_use_pretty_urls() ) {
-                        $bbp->search_query->pagination_links = str_replace( bbp_get_paged_slug() . '/1/', '', $bbp->search_query->pagination_links );
-                } else {
-                        $bbp->search_query->pagination_links = preg_replace( '/&paged=1(?=[^0-9])/m', '', $bbp->search_query->pagination_links );
-                }
+                $bbp->search_query->pagination_links = bbp_paginate_links( $bbp_search_pagination );
         }
 
@@ -343 +309 @@
                 return apply_filters( 'bbp_get_search_terms', $search_terms, $passed_terms );
         }
+
+/** Pagination ****************************************************************/
+
+/**
+ * Return the base URL used inside of pagination links
+ *
+ * @since 2.6.0 bbPress (r6679)
+ *
+ * @return string
+ */
+function bbp_get_search_pagination_base() {
+
+        // If pretty permalinks are enabled, make our pagination pretty
+        if ( bbp_use_pretty_urls() ) {
+
+                // Shortcode territory
+                if ( is_page() || is_single() ) {
+                        $base = trailingslashit( get_permalink() );
+
+                // Default search location
+                } else {
+                        $base = trailingslashit( bbp_get_search_results_url() );
+                }
+
+                // Add pagination base
+                $base = $base . user_trailingslashit( bbp_get_paged_slug() . '/%#%/' );
+
+        // Unpretty permalinks
+        } else {
+                $base = add_query_arg( 'paged', '%#%' );
+        }
+
+        // Filter & return
+        return apply_filters( 'bbp_get_search_pagination_base', $base );
+}
 
 /**