Changeset 4928

Timestamp:

05/19/2013 06:29:35 AM (12 years ago)

Author:

johnjamesjacoby

Message:

Introduce bbp_search_results_url(), bbp_get_search_results_url(), and bbp_search_template_redirect(), to handle the new search results page routing. See #2337.

Location:

trunk/includes/search

Files:

• functions.php (modified) (1 diff)
• template-tags.php (modified) (6 diffs)

trunk/includes/search/functions.php

@@ -54 +54 @@
     return apply_filters( 'bbp_get_search_query_args', $retval );
 }
+
+/**
+ * Redirect to search results page if needed
+ *
+ * @since bbPress (r4928)
+ * @return If a redirect is not needed
+ */
+function bbp_search_template_redirect() {
+
+    // Bail if already on search results page
+    if ( bbp_is_search_results() )
+        return;
+
+    // Bail if search terms are empty
+    if ( false === bbp_get_search_terms() )
+        return;
+
+    // Get the redirect URL
+    $redirect_to = bbp_get_search_results_url();
+
+    // Bail if no redirect URL or may cause infinite loop
+    if ( empty( $redirect_to ) || ( bbp_get_search_url() === $redirect_to ) )
+        return;
+
+    // Redirect and bail
+    wp_safe_redirect( $redirect_to );
+    exit();
+}

trunk/includes/search/template-tags.php

@@ -44 +44 @@
     /** Defaults **************************************************************/
 
-    // What are the default allowed statuses (based on user caps)
-    if ( bbp_get_view_all( 'edit_others_replies' ) ) {
-        $post_statuses = array( bbp_get_public_status_id(), bbp_get_closed_status_id(), bbp_get_spam_status_id(), bbp_get_trash_status_id() );
-    } else {
-        $post_statuses = array( bbp_get_public_status_id(), bbp_get_closed_status_id() );
-    }
-
-    $default_post_type   = array( bbp_get_forum_post_type(), bbp_get_topic_post_type(), bbp_get_reply_post_type() );
-    $default_post_status = implode( ',', $post_statuses );
+    $default_post_type = array( bbp_get_forum_post_type(), bbp_get_topic_post_type(), bbp_get_reply_post_type() );
 
     // Default query args
     $default = array(
-        'post_type'      => $default_post_type,         // Forums, topics, and replies
-        'post_status'    => $default_post_status,       // Of this status
-        'posts_per_page' => bbp_get_replies_per_page(), // This many
-        'paged'          => bbp_get_paged(),            // On this page
-        'orderby'        => 'date',                     // Sorted by date
-        'order'          => 'DESC',                     // Most recent first
-        's'              => bbp_get_search_terms(),     // This is a search
+        'post_type'           => $default_post_type,         // Forums, topics, and replies
+        'posts_per_page'      => bbp_get_replies_per_page(), // This many
+        'paged'               => bbp_get_paged(),            // On this page
+        'orderby'             => 'date',                     // Sorted by date
+        'order'               => 'DESC',                     // Most recent first
+        'ignore_sticky_posts' => true,                       // Stickies not supported
+        's'                   => bbp_get_search_terms(),     // This is a search
     );
+
+    // What are the default allowed statuses (based on user caps)
+    if ( bbp_get_view_all() ) {
+
+        // Default view=all statuses
+        $post_statuses = array(
+            bbp_get_public_status_id(),
+            bbp_get_closed_status_id(),
+            bbp_get_spam_status_id(),
+            bbp_get_trash_status_id()
+        );
+
+        // Add support for private status
+        if ( current_user_can( 'read_private_topics' ) ) {
+            $post_statuses[] = bbp_get_private_status_id();
+        }
+
+        // Join post statuses together
+        $default['post_status'] = implode( ',', $post_statuses );
+
+    // Lean on the 'perm' query var value of 'readable' to provide statuses
+    } else {
+        $default['perm'] = 'readable';
+    }
 
     /** Setup *****************************************************************/
@@ -94 +110 @@
     if ( (int) $bbp->search_query->found_posts && (int) $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 ( $wp_rewrite->using_permalinks() ) {
@@ -103 +122 @@
             // Default search location
             } else {
-                $base = trailingslashit( bbp_get_search_url() );
-
+                $base = trailingslashit( bbp_get_search_results_url() );
             }
 
@@ -116 +134 @@
 
         // Add args
-        $add_args = isset( $_GET[bbp_get_search_rewrite_id()] ) ? array( bbp_get_search_rewrite_id() => urlencode( bbp_get_search_terms() ) ) : array();
-        if ( bbp_get_view_all() )
+        if ( bbp_get_view_all() ) {
             $add_args['view'] = 'all';
+        }
 
         // Add pagination to query object
@@ -253 +271 @@
         // Unpretty permalinks
         } else {
-            $search_terms = bbp_get_search_terms();
+            $url = add_query_arg( array( 'bbp_search' => '' ), home_url( '/' ) );
+        }
+
+        return apply_filters( 'bbp_get_search_url', $url );
+    }
+
+/**
+ * Output the search results url
+ *
+ * @since bbPress (r4928)
+ *
+ * @uses bbp_get_search_url() To get the search url
+ */
+function bbp_search_results_url() {
+    echo bbp_get_search_results_url();
+}
+    /**
+     * Return the search url
+     *
+     * @since bbPress (r4928)
+     *
+     * @uses user_trailingslashit() To fix slashes
+     * @uses trailingslashit() To fix slashes
+     * @uses bbp_get_forums_url() To get the root forums url
+     * @uses bbp_get_search_slug() To get the search slug
+     * @uses add_query_arg() To help make unpretty permalinks
+     * @return string Search url
+     */
+    function bbp_get_search_results_url() {
+        global $wp_rewrite;
+
+        // Get the search terms
+        $search_terms = bbp_get_search_terms();
+
+        // Pretty permalinks
+        if ( $wp_rewrite->using_permalinks() ) {
+
+            // Root search URL
+            $url = $wp_rewrite->root . bbp_get_search_slug();
+
+            // Append search terms
+            if ( !empty( $search_terms ) ) {
+                $url = user_trailingslashit( $url ) . user_trailingslashit( urlencode( $search_terms ) );
+            }
+
+            // Run through home_url()
+            $url = home_url( user_trailingslashit( $url ) );
+
+        // Unpretty permalinks
+        } else {
             $url = add_query_arg( array( 'bbp_search' => urlencode( $search_terms ) ), home_url( '/' ) );
         }
 
-        return apply_filters( 'bbp_get_search_url', $url );
-    }
-
+        return apply_filters( 'bbp_get_search_results_url', $url );
+    }
 
 /**
@@ -297 +363 @@
         }
 
-        // Set explicitly to false if empty
-        if ( empty( $search_terms ) ) {
-            $search_terms = false;
-        }
+        // Trim whitespace and decode, or set explicitly to false if empty
+        $search_terms = !empty( $search_terms ) ? urldecode( trim( $search_terms ) ) : false;
 
         return apply_filters( 'bbp_get_search_terms', $search_terms, $passed_terms );