Changeset 11212

Timestamp:

10/26/2016 03:12:54 AM (5 years ago)

Author:

dcavins

Message:

Improve backward compatibility in groups_get_group().

In r11090, we changed the signature of groups_get_group() to accept
an integer and added backcompat for the most commonly used former
signature, an associative array. However, it was also possible to use a
query-string-style argument. This commit covers that case.

Fixes #7302 (for 2.7 branch).

Location:

branches/2.7

Files:

• src/bp-groups/bp-groups-functions.php (modified) (1 diff)
• tests/phpunit/testcases/groups/functions.php (modified) (1 diff)

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

@@ -44 +44 @@
  */
 function groups_get_group( $group_id ) {
-    // Backward compatibilty.
-    if ( is_array( $group_id ) && isset( $group_id['group_id'] ) ) {
-        $group_id = $group_id['group_id'];
+    /*
+     * Backward compatibilty.
+     * Old-style arguments take the form of an array or a query string.
+     */
+    if ( ! is_numeric( $group_id ) ) {
+        $r = wp_parse_args( $group_id, array(
+            'group_id'        => false,
+            'load_users'      => false,
+            'populate_extras' => false,
+        ) );
+
+        $group_id = $r['group_id'];
     }
 

branches/2.7/tests/phpunit/testcases/groups/functions.php

@@ -668 +668 @@
         $this->assertEquals( $g1, $child->parent_id );
     }
+
+    /**
+     * @group groups_get_group
+     * @ticket BP7302
+     */
+    public function test_groups_get_group_accept_integer() {
+        $g1 = $this->factory->group->create();
+        $group = groups_get_group( $g1 );
+
+        $this->assertEquals( $g1, $group->id );
+    }
+
+    /**
+     * @group groups_get_group
+     * @ticket BP7302
+     */
+    public function test_groups_get_group_accept_numeric() {
+        $g1 = $this->factory->group->create();
+        $group = groups_get_group( (string) $g1 );
+
+        $this->assertEquals( $g1, $group->id );
+    }
+
+    /**
+     * @group groups_get_group
+     * @ticket BP7302
+     */
+    public function test_groups_get_group_accept_array() {
+        $g1 = $this->factory->group->create();
+        $group = groups_get_group( array( 'group_id' => $g1 ) );
+
+        $this->assertEquals( $g1, $group->id );
+    }
+
+    /**
+     * @group groups_get_group
+     * @ticket BP7302
+     */
+    public function test_groups_get_group_accept_query_string() {
+        $g1 = $this->factory->group->create();
+        $group = groups_get_group( 'group_id=' . $g1 );
+
+        $this->assertEquals( $g1, $group->id );
+    }
 }