Changeset 11523

Timestamp:

04/05/2017 12:00:40 AM (8 years ago)

Author:

dcavins

Message:

Add 'slug' parameter to BP_Groups_Group::get().

Add $slug parameter to groups_get_groups() and its underlying
function BP_Groups_Group::get(). Find a group or groups by passing a
single slug, a comma- or space-separated list of slugs, or any array of
slugs.

Fixes #7496.

Location:

trunk

Files:

• src/bp-groups/bp-groups-functions.php (modified) (2 diffs)
• src/bp-groups/classes/class-bp-groups-group.php (modified) (4 diffs)
• tests/phpunit/testcases/groups/class-bp-groups-group.php (modified) (1 diff)

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

@@ -709 +709 @@
         'exclude'            => false,          // Do not include these specific groups (group_ids).
         'parent_id'          => null,           // Get groups that are children of the specified group(s).
+        'slug'               => array(),        // Find a group or groups by slug.
         'search_terms'       => false,          // Limit to groups that match these search terms.
         'search_columns'     => array(),        // Select which columns to search.
@@ -729 +730 @@
         'include'            => $r['include'],
         'exclude'            => $r['exclude'],
+        'slug'               => $r['slug'],
         'parent_id'          => $r['parent_id'],
         'search_terms'       => $r['search_terms'],

trunk/src/bp-groups/classes/class-bp-groups-group.php

@@ -861 +861 @@
      * @since 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters.
      * @since 2.7.0 Added `$update_admin_cache` and `$parent_id` parameters.
+     * @since 2.9.0 Added `$slug` parameter.
      *
      * @param array $args {
@@ -877 +878 @@
      *     @type int          $user_id            Optional. If provided, results will be limited to groups
      *                                            of which the specified user is a member. Default: null.
-     *     @type string       $search_terms       Optional. If provided, only groups whose names or descriptions
+     *     @type array|string $slug               Optional. Array or comma-separated list of group slugs to limit
+     *                                            results to.
+     *                                            Default: false.
+     *     @type string       $search_terms       Optional. If provided, only groups whose names or descriptions
      *                                            match the search terms will be returned. Allows specifying the
      *                                            wildcard position using a '*' character before or after the
@@ -939 +943 @@
             'page'               => null,
             'user_id'            => 0,
+            'slug'               => array(),
             'search_terms'       => false,
             'search_columns'     => array(),
@@ -973 +978 @@
         if ( empty( $r['show_hidden'] ) ) {
             $where_conditions['hidden'] = "g.status != 'hidden'";
+        }
+
+        if ( ! empty( $r['slug'] ) ) {
+            if ( ! is_array( $r['slug'] ) ) {
+                $r['slug'] = preg_split( '/[\s,]+/', $r['slug'] );
+            }
+            $r['slug'] = array_map( 'sanitize_title', $r['slug'] );
+            $slug_in = "'" . implode( "','", $r['slug'] ) . "'";
+            $where_conditions['slug'] = "g.slug IN ({$slug_in})";
         }
 

trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php

@@ -2012 +2012 @@
         $this->assertEqualSets( array( $g1, $g4 ), $found );
     }
+
+    /**
+     * @group get_by_slug
+     */
+    public function test_get_by_slug() {
+        $g1 = $this->factory->group->create(array(
+            'slug'      => 'apr'
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'slug'      => 'jan'
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'slug'      => 'mar'
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'slug' => array( 'apr', 'mar' ),
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEqualSets( array( $g1, $g3 ), $found );
+    }
+
+    /**
+     * @group get_by_slug
+     */
+    public function test_get_by_slug_accept_string() {
+        $g1 = $this->factory->group->create(array(
+            'slug'      => 'apr'
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'slug'      => 'jan'
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'slug'      => 'mar'
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'slug' => 'jan',
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEqualSets( array( $g2 ), $found );
+    }
+
+    /**
+     * @group get_by_slug
+     */
+    public function test_get_by_slug_accept_comma_separated_string() {
+        $g1 = $this->factory->group->create(array(
+            'slug'      => 'apr'
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'slug'      => 'jan'
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'slug'      => 'mar'
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'slug' => 'apr, mar',
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEqualSets( array( $g1, $g3 ), $found );
+    }
+
+    /**
+     * @group get_by_slug
+     */
+    public function test_get_by_slug_accept_space_separated_string() {
+        $g1 = $this->factory->group->create(array(
+            'slug'      => 'apr'
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'slug'      => 'jan'
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'slug'      => 'mar'
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'slug' => 'apr mar',
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEqualSets( array( $g1, $g3 ), $found );
+    }
+
 }