Changeset 8675

Timestamp:

07/23/2014 05:56:57 PM (11 years ago)

Author:

djpaul

Message:

Core: add new search_wildcard parameter to BP_User_Query.

This new parameter controls where BuddyPress places MySQL wildcard characters around the search term (when it's set).
Prior to this change, BuddyPress added a wildcard character to both ends of the search term, but for some use cases, a more restrictive search pattern is required; you can specify "left", "right", or "both" (the default) to pick where the wildcard is added.

Fixes #5769

Location:

trunk

Files:

• src/bp-core/bp-core-classes.php (modified) (3 diffs)
• src/bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)
• tests/phpunit/testcases/core/class-bp-user-query.php (modified) (1 diff)

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

@@ -31 +31 @@
  *           across xprofile fields. Requires XProfile component.
  *           Default: false.
+ *     @type string $search_wildcard When searching with $search_terms,
+ *           set where wildcards around the term should be positioned.
+ *           Default: 'both'. Other values: 'left', 'right'.
  *     @type array|string|bool $include An array or comma-separated list of
  *           user IDs to which query should be limited.
@@ -154 +157 @@
                 'user_id'         => 0,
                 'search_terms'    => false,
+                'search_wildcard' => 'both',
                 'include'         => false,
                 'exclude'         => false,
@@ -365 +369 @@
         // xprofile field matches happen in bp_xprofile_bp_user_query_search()
         if ( false !== $search_terms ) {
-            $search_terms_like = '%' . bp_esc_like( $search_terms ) . '%';
+            $search_terms_like = bp_esc_like( $search_terms );
+
+            if ( $search_wildcard === 'left' ) {
+                $search_terms_like = '%' . $search_terms_like;
+            } elseif ( $search_wildcard === 'right' ) {
+                $search_terms_like = $search_terms_like . '%';
+            } else {
+                $search_terms_like = '%' . $search_terms_like . '%';
+            }
+
             $sql['where']['search'] = $wpdb->prepare( "u.{$this->uid_name} IN ( SELECT ID FROM {$wpdb->users} WHERE ( user_login LIKE %s OR user_nicename LIKE %s ) )", $search_terms_like, $search_terms_like );
         }

trunk/src/bp-xprofile/bp-xprofile-functions.php

@@ -596 +596 @@
     $search_terms_clean = esc_sql( esc_sql( $query->query_vars['search_terms'] ) );
 
+    if ( $query->query_vars['search_wildcard'] === 'left' ) {
+        $search_terms_clean = '%' . $search_terms_clean;
+    } elseif ( $query->query_vars['search_wildcard'] === 'right' ) {
+        $search_terms_clean = $search_terms_clean . '%';
+    } else {
+        $search_terms_clean = '%' . $search_terms_clean . '%';
+    }
+
     // Combine the core search (against wp_users) into a single OR clause
     // with the xprofile_data search
     $search_core     = $sql['where']['search'];
-    $search_xprofile = "u.{$query->uid_name} IN ( SELECT user_id FROM {$bp->profile->table_name_data} WHERE value LIKE '%{$search_terms_clean}%' )";
+    $search_xprofile = "u.{$query->uid_name} IN ( SELECT user_id FROM {$bp->profile->table_name_data} WHERE value LIKE '{$search_terms_clean}' )";
     $search_combined = "( {$search_xprofile} OR {$search_core} )";
 

trunk/tests/phpunit/testcases/core/class-bp-user-query.php

@@ -220 +220 @@
         $this->assertEquals( $user_id, $found_user_id );
     }
+
+    public function test_bp_user_query_search_wildcards() {
+        $u1 = $this->create_user( array(
+            'user_login' => 'xfoo',
+        ) );
+        xprofile_set_field_data( 1, $u1, "Bar" );
+        $q1 = new BP_User_Query( array( 'search_terms' => 'foo', 'search_wildcard' => 'left' ) );
+
+        $u2 = $this->create_user( array(
+            'user_login' => 'foox',
+        ) );
+        xprofile_set_field_data( 1, $u2, "Bar" );
+        $q2 = new BP_User_Query( array( 'search_terms' => 'foo', 'search_wildcard' => 'right' ) );
+
+        $u3 = $this->create_user( array(
+            'user_login' => 'xfoox',
+        ) );
+        xprofile_set_field_data( 1, $u3, "Bar" );
+        $q3 = new BP_User_Query( array( 'search_terms' => 'foo', 'search_wildcard' => 'both' ) );
+
+        $this->assertNotEmpty( $q1->results );
+        $q1 = array_pop( $q1->results );
+        $this->assertEquals( $u1, $q1->ID );
+
+        $this->assertNotEmpty( $q2->results );
+        $q2 = array_pop( $q2->results );
+        $this->assertEquals( $u2, $q2->ID );
+
+        $this->assertNotEmpty( $q3->results );
+        foreach ( $q3->results as $user ) {
+            $this->assertTrue( in_array( $user->ID, array( $u1, $u2, $u3 ) ) );
+        }
+    }
+
     /**
      * @group exclude