Changeset 13085 for trunk/src/bp-groups/bp-groups-functions.php

Timestamp:

08/22/2021 12:38:43 AM (4 years ago)

Author:

espellcaste

Message:

We are introducing in this commit two new helper functions to get a group: bp_get_group_by and bp_get_group. The former allows for getting a group by id/ID or slug.
And the latter allows for getting a group by id/ID, group object, slug. And when used in the context of a Group loop built by the BP_Groups_Template class, it defaults to the Group being iterated on.

• The new helper functions were applied to several functions in the Group component.
• bp_group_is_visible was updated to check against a specific user ID. Previously, only the current logged in user was verified.
• bp_get_group_avatar was updated to use the new functions and new arguments that are passed to bp_core_fetch_avatar were added.
• PHPDoc were updated to reflect those changes.

Props imath, boonebgorges and DJPaul

Fixes #6749 (trunk)

File:

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

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

@@ -68 +68 @@
      */
     return apply_filters( 'groups_get_group', $group );
+}
+
+/**
+ * Retrieve group by a given field.
+ *
+ * @since 10.0.0
+ *
+ * @param string     $field (Required) The field to use to retrieve the group.
+ *                          Possible values are `'id'` or `'slug'`.
+ * @param string|int $value (Required) A value for the $field. A Group ID or slug.
+ * @return BP_Groups_Group|false The Group object if found, false otherwise.
+ */
+function bp_get_group_by( $field, $value ) {
+    $group_id = $value;
+
+    if ( 'slug' === $field && is_string( $value ) ) {
+        $group_id = groups_get_id( $value );
+    }
+
+    $group = groups_get_group( array( 'group_id' => (int) $group_id ) );
+
+    if ( empty( $group->id ) ) {
+        return false;
+    }
+
+    return $group;
+}
+
+/**
+ * Retrieve a Group.
+ *
+ * When used into the context of a Groups loop built by the `BP_Groups_Template` class, it defaults to the
+ * Group being iterated on.
+ *
+ * @since 10.0.0
+ *
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
+ * @return BP_Groups_Group|false                  The Group object if found, false otherwise.
+ */
+function bp_get_group( $group = false ) {
+    global $groups_template;
+
+    $group_obj = false;
+
+    if ( $group instanceof BP_Groups_Group ) {
+        $group_obj = $group;
+    } elseif ( is_string( $group ) ) {
+        $group_obj = bp_get_group_by( 'slug', $group );
+    } elseif ( is_numeric( $group ) ) {
+        $group_obj = bp_get_group_by( 'id', $group );
+    } elseif ( isset( $groups_template->group ) && is_object( $groups_template->group ) ) {
+        $group_obj = $groups_template->group;
+    }
+
+    return $group_obj;
 }