Changeset 11532

Timestamp:

04/20/2017 12:19:36 AM (8 years ago)

Author:

dcavins

Message:

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

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

Fixes #7501.

Location:

trunk

Files:

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

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

@@ -718 +718 @@
         'meta_query'         => false,          // Filter by groupmeta. See WP_Meta_Query for syntax.
         'show_hidden'        => false,          // Show hidden groups to non-admins.
+        'status'             => array(),        // Array or comma-separated list of group statuses to limit results to.
         'per_page'           => 20,             // The number of results to return per page.
         'page'               => 1,              // The page to return if limiting per page.
@@ -740 +741 @@
         'meta_query'         => $r['meta_query'],
         'show_hidden'        => $r['show_hidden'],
+        'status'             => $r['status'],
         'per_page'           => $r['per_page'],
         'page'               => $r['page'],

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

@@ -920 +920 @@
      *                                            groups. Default: false.
      *     @type bool         $show_hidden        Whether to include hidden groups in results. Default: false.
+     *     @type array|string $status             Optional. Array or comma-separated list of group statuses to limit
+     *                                            results to. If specified, $show_hidden is ignored.
+     *                                            Default: empty array.
      * }
      * @return array {
@@ -970 +973 @@
             'exclude'            => false,
             'show_hidden'        => false,
+            'status'             => array()
         );
 
@@ -990 +994 @@
         $where_conditions = array();
 
-        if ( empty( $r['show_hidden'] ) ) {
+
+        if ( ! empty( $r['status'] ) ) {
+            if ( ! is_array( $r['status'] ) ) {
+                $r['status'] = preg_split( '/[\s,]+/', $r['status'] );
+            }
+            $r['status'] = array_map( 'sanitize_title', $r['status'] );
+            $status_in = "'" . implode( "','", $r['status'] ) . "'";
+            $where_conditions['status'] = "g.status IN ({$status_in})";
+        } elseif ( empty( $r['show_hidden'] ) ) {
             $where_conditions['hidden'] = "g.status != 'hidden'";
         }

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

@@ -2117 +2117 @@
     }
 
+    /**
+     * @group get_by_status
+     */
+    public function test_get_by_status() {
+        $g1 = $this->factory->group->create(array(
+            'status'      => 'private'
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'status'      => 'public'
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'status'      => 'hidden'
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'status' => array( 'private', 'hidden' ),
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEqualSets( array( $g1, $g3 ), $found );
+    }
+
+    /**
+     * @group get_by_status
+     */
+    public function test_get_by_status_accept_string() {
+        $g1 = $this->factory->group->create(array(
+            'status'      => 'private'
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'status'      => 'public'
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'status'      => 'hidden'
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'status' => 'public',
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEqualSets( array( $g2 ), $found );
+    }
+
+    /**
+     * @group get_by_status
+     */
+    public function test_get_by_status_accept_comma_separated_string() {
+        $g1 = $this->factory->group->create(array(
+            'status'      => 'private'
+        ) );
+        $g2 = $this->factory->group->create( array(
+            'status'      => 'public'
+        ) );
+        $g3 = $this->factory->group->create( array(
+            'status'      => 'hidden'
+        ) );
+
+        $groups = BP_Groups_Group::get( array(
+            'status' => 'private, hidden',
+        ) );
+
+        $found = wp_list_pluck( $groups['groups'], 'id' );
+        $this->assertEqualSets( array( $g1, $g3 ), $found );
+    }
+
 }