Changeset 10110 for trunk/src/bp-core/bp-core-component.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-core/bp-core-component.php (modified) (4 diffs)

trunk/src/bp-core/bp-core-component.php

@@ -127 +127 @@
     public $global_tables = array();
 
+    /**
+     * Query argument for component search URLs.
+     *
+     * @since 2.4.0
+     * @var string
+     */
+    public $search_query_arg = 's';
+
     /** Methods ***************************************************************/
 
@@ -135 +143 @@
      * @since 1.9.0 Added $params as a parameter.
      * @since 2.3.0 Added $params['features'] as a configurable value.
+     * @since 2.4.0 Added $params['search_query_arg'] as a configurable value.
      *
      * @param string $id   Unique ID. Letters, numbers, and underscores only.
@@ -142 +151 @@
      * @param array  $params {
      *     Additional parameters used by the component.
-     *     @type int   $adminbar_myaccount_order Set the position for our menu under the WP Toolbar's "My Account menu".
-     *     @type array $features                 An array of feature names. This is used to load additional files from your
-     *                                           component directory and for feature active checks. eg. array( 'awesome' )
-     *                                           would look for a file called "bp-{$this->id}-awesome.php" and you could use
-     *                                           bp_is_active( $this->id, 'awesome' ) to determine if the feature is active.
+     *     @type int    $adminbar_myaccount_order Set the position for our menu under the WP Toolbar's "My Account menu".
+     *     @type array  $features                 An array of feature names. This is used to load additional files from your
+     *                                            component directory and for feature active checks. eg. array( 'awesome' )
+     *                                            would look for a file called "bp-{$this->id}-awesome.php" and you could use
+     *                                            bp_is_active( $this->id, 'awesome' ) to determine if the feature is active.
+     *     @type string $search_query_arg         String to be used as the query argument in component search URLs.
      * }
      */
@@ -170 +180 @@
             if ( ! empty( $params['features'] ) ) {
                 $this->features = array_map( 'sanitize_title', (array) $params['features'] );
+            }
+
+            if ( ! empty( $params['search_query_arg'] ) ) {
+                $this->search_query_arg = sanitize_title( $params['search_query_arg'] );
             }