Changeset 5232 for trunk/includes/extend/buddypress/functions.php

Timestamp:

12/23/2013 09:29:19 PM (11 years ago)

Author:

johnjamesjacoby

Message:

Introduce helper function for getting the BuddyPress component name, and filter new BuddyPress function to include it in registered components. Fixes #2495. Hat-tip imath. (trunk)

File:

• trunk/includes/extend/buddypress/functions.php (modified) (1 diff)

trunk/includes/extend/buddypress/functions.php

@@ -13 +13 @@
 
 /** BuddyPress Helpers ********************************************************/
+
+/**
+ * Return bbPress's component name/ID ('forums' by default)
+ *
+ * This is used primarily for Notifications integration.
+ *
+ * @since bbPress (r5232)
+ * @return string
+ */
+function bbp_get_component_name() {
+
+    // Use existing ID
+    if ( !empty( bbpress()->extend->buddypress->id ) ) {
+        $retval = bbpress()->extend->buddypress->id;
+
+    // Use default
+    } else {
+        $retval = 'forums';
+    }
+
+    return apply_filters( 'bbp_get_component_name', $retval );
+}
 
 /**