Changeset 11090

Timestamp:

09/13/2016 05:35:46 AM (8 years ago)

Author:

boonebgorges

Message:

Accept a group ID instead of an array in groups_get_group().

The fact that groups_get_group() required an array was an annoying
side-effect of the fact that BP_Groups_Group had a 'populate_extras'
argument. Now that the latter is gone, the function signature can be
simplified.

See #5451.

File:

• trunk/src/bp-groups/bp-groups-functions.php (modified) (1 diff)

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

@@ -37 +37 @@
  *
  * @since 1.2.0
- *
- * @param array|string $args {
- *     Array of al arguments.
- *     @type int  $group_id        ID of the group.
- *     @type bool $load_users      No longer used.
- *     @type bool $populate_extras Whether to fetch membership data and other
- *                                 extra information about the group.
- *                                 Default: false.
- * }
+ * @since 2.7.0 The function signature was changed to accept a group ID only,
+ *              instead of an array containing the group ID.
+ *
+ * @param int $group_id ID of the group.
  * @return BP_Groups_Group $group The group object.
  */
 function groups_get_group( $args = '' ) {
-    $r = wp_parse_args( $args, array(
-        'group_id'          => false,
-        'load_users'        => false,
-        'populate_extras'   => false,
-    ) );
-
-    $group_args = array(
-        'populate_extras' => $r['populate_extras'],
-    );
-
-    $group = new BP_Groups_Group( $r['group_id'], $group_args );
+    // Backward compatibilty.
+    if ( is_array( $args ) && isset( $args['group_id'] ) ) {
+        $group_id = $args['group_id'];
+    }
+
+    $group = new BP_Groups_Group( $group_id );
 
     /**