Changeset 12744

Timestamp:

10/09/2020 01:25:47 PM (4 years ago)

Author:

dcavins

Message:

Support status parameter in bp_has_groups().

Allow a status parameter to be passed through bp_has_groups() to its underlying function, groups_has_groups().

Fixes #8310.

Location:

trunk

Files:

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

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

@@ -294 +294 @@
  * @since 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters.
  * @since 2.7.0 Added `$update_admin_cache` parameter.
+ * @since 7.0.0 Added `$status` parameter.
  *
  * @param array|string $args {
@@ -320 +321 @@
  *     @type array|string $group_type__not_in Array or comma-separated list of group types that will be
  *                                            excluded from results.
+ *     @type array|string $status             Array or comma-separated list of group statuses to limit results to.
  *     @type array        $meta_query         An array of meta_query conditions.
  *                                            See {@link WP_Meta_Query::queries} for description.
@@ -370 +372 @@
             // Can be a comma-separated list.
             $group_type = explode( ',', $_GET['group_type'] );
+        }
+    }
+
+    $status = array();
+    if ( ! empty( $_GET['status'] ) ) {
+        if ( is_array( $_GET['status'] ) ) {
+            $status = $_GET['status'];
+        } else {
+            // Can be a comma-separated list.
+            $status = explode( ',', $_GET['status'] );
         }
     }
@@ -399 +411 @@
         'group_type__in'     => '',
         'group_type__not_in' => '',
+        'status'             => $status,
         'meta_query'         => false,
         'include'            => false,
@@ -423 +436 @@
         'group_type__in'     => $r['group_type__in'],
         'group_type__not_in' => $r['group_type__not_in'],
+        'status'             => $r['status'],
         'meta_query'         => $r['meta_query'],
         'include'            => $r['include'],

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

@@ -172 +172 @@
             'group_type__in'     => '',
             'group_type__not_in' => '',
+            'status'             => array(),
             'meta_query'         => false,
             'update_meta_cache'  => true,
@@ -225 +226 @@
                 'group_type__in'     => $group_type__in,
                 'group_type__not_in' => $group_type__not_in,
+                'status'             => $status,
                 'include'            => $include,
                 'exclude'            => $exclude,

trunk/tests/phpunit/testcases/groups/template.php

@@ -116 +116 @@
         $ids = wp_parse_id_list( wp_list_pluck( $groups_template->groups, 'id' ) );
         $this->assertEquals( array( $g1 ), $ids );
+
+        $this->assertEquals( 1, $groups_template->group_count );
+    }
+
+    /**
+     * Test using the 'status' parameter in bp_has_groups()
+     *
+     * @group bp_has_groups
+     */
+    public function test_bp_has_groups_status() {
+        $g1 = self::factory()->group->create( array(
+            'status' => 'public',
+        ) );
+        $g2 = self::factory()->group->create( array(
+            'status' => 'private',
+        ) );
+        $g3 = self::factory()->group->create( array(
+            'status' => 'hidden',
+        ) );
+
+        global $groups_template;
+        bp_has_groups( array(
+            'status' => 'private',
+        ) );
+
+        $ids = wp_parse_id_list( wp_list_pluck( $groups_template->groups, 'id' ) );
+        $this->assertEqualSets( array( $g2 ), $ids );
 
         $this->assertEquals( 1, $groups_template->group_count );