Ticket #7496: 7496.1.diff

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

@@ -708 +708 @@
                 'include'            => false,          // Only include these specific groups (group_ids).
                 '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.
                 'group_type'         => '',             // Array or comma-separated list of group types to limit results to.
@@ -728 +729 @@
                 'user_id'            => $r['user_id'],
                 'include'            => $r['include'],
                 'exclude'            => $r['exclude'],
+                'slug'               => $r['slug'],
                 'parent_id'          => $r['parent_id'],
                 'search_terms'       => $r['search_terms'],
                 'search_columns'     => $r['search_columns'],

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

@@ -860 +860 @@
          * @since 1.6.0
          * @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 {
          *     Array of parameters. All items are optional.
@@ -876 +877 @@
          *                                            Default: null (no limit).
          *     @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
          *                                            string or both. Works in concert with $search_columns.
@@ -938 +942 @@
                         'per_page'           => null,
                         'page'               => null,
                         'user_id'            => 0,
+                        'slug'               => array(),
                         'search_terms'       => false,
                         'search_columns'     => array(),
                         'group_type'         => '',
@@ -974 +979 @@
                         $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})";
+                }
+
                 $search = '';
                 if ( isset( $r['search_terms'] ) ) {
                         $search = trim( $r['search_terms'] );

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

@@ -2011 +2011 @@
                 $found = wp_list_pluck( $groups['groups'], 'id' );
                 $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 );
+        }
+
 }
 
 /**