Changeset 10110 for trunk/src/bp-blogs/bp-blogs-template.php

Timestamp:

09/14/2015 03:39:38 PM (10 years ago)

Author:

boonebgorges

Message:

When a copmonent directory is set to the front page, don't interfere with blog searches.

WP's default search query arg is 's', so that URLs like example.com?s=foo lead
to a search of blog posts on the term 'foo'. When a BuddyPress component page
like Members is set to the front page, it interferes with this behavior in two
ways: (1) BuddyPress interprets example.com?s=foo as a Members directory
request, and (2) the 's' query arg is interpreted as a Members search term.

We fix this conflict as follows:

• During the URL parsing process, don't interpret requests of the form example.com?s=foo as being BP component requests, even if a BP component is set to the front page.
• In order to make BuddyPress component searches continue to work, we change the default search query arguments for each component to be unique. For example, member directory searches look like example.com?members_search=foo. Components register their own 'search_query_arg', and these args can be filtered with the new 'bp_core_get_component_search_query_arg' filter.

Fixes #5087.

File:

• trunk/src/bp-blogs/bp-blogs-template.php (modified) (4 diffs)

trunk/src/bp-blogs/bp-blogs-template.php

@@ -385 +385 @@
  *     @type array    $include_blog_ids Array of blog IDs to limit results to.
  *     @type string   $sort             'ASC' or 'DESC'. Default: 'DESC'.
- *     @type string   $search_terms     Limit results by a search term. Default: the
- *                                      value of $_REQUEST['s'], if present.
+ *     @type string   $search_terms     Limit results by a search term. Default: the value of `$_REQUEST['s']` or
+ *                                      `$_REQUEST['sites_search']`, if present.
  *     @type int      $user_id          The ID of the user whose blogs should be retrieved.
  *                                      When viewing a user profile page, 'user_id' defaults to the
@@ -396 +396 @@
     global $blogs_template;
 
-    // Check for and use search terms
-    $search_terms = ! empty( $_REQUEST['s'] )
-        ? $_REQUEST['s']
-        : false;
+    // Check for and use search terms.
+    $search_terms_default = false;
+    $search_query_arg = bp_core_get_component_search_query_arg( 'blogs' );
+    if ( ! empty( $_REQUEST[ $search_query_arg ] ) ) {
+        $search_terms_default = stripslashes( $_REQUEST[ $search_query_arg ] );
+    } elseif ( ! empty( $_REQUEST['s'] ) ) {
+        $search_terms_default = stripslashes( $_REQUEST['s'] );
+    }
 
     // Parse arguments
@@ -410 +414 @@
         'user_id'           => bp_displayed_user_id(), // Pass a user_id to limit to only blogs this user is a member of
         'include_blog_ids'  => false,
-        'search_terms'      => $search_terms,          // Pass search terms to filter on the blog title or description.
+        'search_terms'      => $search_terms_default,
         'update_meta_cache' => true
     ), 'has_blogs' );
@@ -1450 +1454 @@
  */
 function bp_directory_blogs_search_form() {
-    $default_search_value = bp_get_search_default_text();
-    $search_value         = !empty( $_REQUEST['s'] ) ? stripslashes( $_REQUEST['s'] ) : $default_search_value;
+
+    $query_arg = bp_core_get_component_search_query_arg( 'blogs' );
+
+    if ( ! empty( $_REQUEST[ $query_arg ] ) ) {
+        $search_value = stripslashes( $_REQUEST[ $query_arg ] );
+    } else {
+        $search_value = bp_get_search_default_text( 'blogs' );
+    }
 
     $search_form_html = '<form action="" method="get" id="search-blogs-form">
-        <label><input type="text" name="s" id="blogs_search" placeholder="'. esc_attr( $search_value ) .'" /></label>
+        <label><input type="text" name="' . esc_attr( $query_arg ) . '" id="blogs_search" placeholder="'. esc_attr( $search_value ) .'" /></label>
         <input type="submit" id="blogs_search_submit" name="blogs_search_submit" value="' . __( 'Search', 'buddypress' ) . '" />
     </form>';