Changeset 11142

Timestamp:

09/21/2016 06:00:05 PM (9 years ago)

Author:

r-a-y

Message:

Groups: In bp_groups_set_group_type(), allow an array of group types to be set.

See #7210.

Location:

trunk

Files:

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

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

@@ -2248 +2248 @@
  *
  * @since 2.6.0
- *
- * @param int    $group      ID of the group.
- * @param string $group_type Group type.
- * @param bool   $append     Optional. True to append this to existing types for group,
- *                           false to replace. Default: false.
+ * @since 2.7.0 $group_type parameter also accepts an array of group types now.
+ *
+ * @param int          $group      ID of the group.
+ * @param string|array $group_type Group type or array of group types to set.
+ * @param bool         $append     Optional. True to append this to existing types for group,
+ *                                 false to replace. Default: false.
  * @return array $retval See bp_set_object_terms().
  */
 function bp_groups_set_group_type( $group_id, $group_type, $append = false ) {
     // Pass an empty group type to remove group's type.
-    if ( ! empty( $group_type ) && ! bp_groups_get_group_type_object( $group_type ) ) {
-        return false;
+    if ( ! empty( $group_type ) && is_string( $group_type ) && ! bp_groups_get_group_type_object( $group_type ) ) {
+        return false;
+    }
+
+    // Cast as array.
+    $group_type = (array) $group_type;
+
+    // Validate group types.
+    foreach ( $group_type as $type ) {
+        // Remove any invalid group types.
+        if ( is_null( bp_groups_get_group_type_object( $type ) ) ) {
+            unset( $group_type[ $type ] );
+        }
     }
 
@@ -2272 +2284 @@
          * @since 2.6.0
          *
-         * @param int    $group_id   ID of the group whose group type has been updated.
-         * @param string $group_type Group type.
-         * @param bool   $append     Whether the type is being appended to existing types.
+         * @param int          $group_id   ID of the group whose group type has been updated.
+         * @param string|array $group_type Group type or array of group types.
+         * @param bool         $append     Whether the type is being appended to existing types.
          */
         do_action( 'bp_groups_set_group_type', $group_id, $group_type, $append );

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

@@ -264 +264 @@
         $this->assertEquals( array( 'foo' ), $type );
     }
+
+    public function test_bp_groups_set_group_type_should_set_multiple_types_when_passing_array_of_types() {
+        $g = $this->factory->group->create( array( 'creator_id' => self::$u1 ) );
+        bp_groups_register_group_type( 'foo' );
+        bp_groups_register_group_type( 'bar' );
+
+        // Set multiple group types.
+        $types = array( 'foo', 'bar' );
+        bp_groups_set_group_type( $g, $types );
+
+        // Assert!
+        $this->assertEqualSets( $types, bp_groups_get_group_type( $g, false ) );
+    }
 }