Changeset 13101

Timestamp:

09/02/2021 04:26:52 PM (3 years ago)

Author:

imath

Message:

Improve the Group Extension API extensibility

• Use a new global to store the registered Group extensions of the Groups component.
• Edit the behavior of the bp_register_group_extension() function so that it only registers custom group extensions into the new global.
• Introduce a new function bp_init_group_extensions() to init the registered Group extensions.

These improvements will make it possible for the BP Rewrites feature as a plugin to allow slug customization of the registered Group extensions.

Props boonebgorges

Fixes #8558

Location:

trunk/src/bp-groups

Files:

• bp-groups-functions.php (modified) (1 diff)
• classes/class-bp-group-extension.php (modified) (2 diffs)
• classes/class-bp-groups-component.php (modified) (1 diff)

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

@@ -3532 +3532 @@
     }
 }
+
+/**
+ * Register a new Group Extension.
+ *
+ * @since 1.1.0
+ * @since 10.0.0 The function was moved from the `/bp-groups/classes/class-bp-group-extension.php` file.
+ *               It only registers Group Extensions if their corresponding class name has not been already
+ *               registered.
+ *
+ * @param string $group_extension_class Name of the Extension class.
+ * @return bool                         Returns true on success, otherwise false.
+ */
+function bp_register_group_extension( $group_extension_class = '' ) {
+    if ( ! class_exists( $group_extension_class ) ) {
+        return false;
+    }
+
+    $bp = buddypress();
+
+    if ( isset( $bp->groups->group_extensions[ $group_extension_class ] ) ) {
+        return false;
+    }
+
+    // Add the new Group extension to the registered ones.
+    $bp->groups->group_extensions[ $group_extension_class ] = true;
+
+    return true;
+}
+
+/**
+ * Init Registered Group Extensions.
+ *
+ * @since 10.0.0
+ */
+function bp_init_group_extensions() {
+    $registered_group_extensions = buddypress()->groups->group_extensions;
+
+    if ( ! $registered_group_extensions ) {
+        return;
+    }
+
+    foreach ( array_keys( $registered_group_extensions ) as $group_extension_class ) {
+        $extension = new $group_extension_class;
+
+        add_action( 'bp_actions', array( &$extension, '_register' ), 8 );
+        add_action( 'admin_init', array( &$extension, '_register' ) );
+    }
+}
+add_action( 'bp_init', 'bp_init_group_extensions', 11 );

trunk/src/bp-groups/classes/class-bp-group-extension.php

@@ -11 +11 @@
 defined( 'ABSPATH' ) || exit;
 
+if ( ! class_exists( 'BP_Group_Extension', false ) ) :
 /**
  * API for creating group extensions without having to hardcode the content into
@@ -1696 +1697 @@
     }
 }
-
-/**
- * Register a new Group Extension.
- *
- * @since 1.1.0
- *
- * @param string $group_extension_class Name of the Extension class.
- * @return false|null Returns false on failure, otherwise null.
- */
-function bp_register_group_extension( $group_extension_class = '' ) {
-
-    if ( ! class_exists( $group_extension_class ) ) {
-        return false;
-    }
-
-    // Register the group extension on the bp_init action so we have access
-    // to all plugins.
-    add_action( 'bp_init', function() use ( $group_extension_class ) {
-        $extension = new $group_extension_class;
-        add_action( 'bp_actions', array( &$extension, '_register' ), 8 );
-        add_action( 'admin_init', array( &$extension, '_register' ) );
-    }, 11 );
-}
+endif; // End class_exists check.

trunk/src/bp-groups/classes/class-bp-groups-component.php

@@ -94 +94 @@
      */
     public $current_directory_type = '';
+
+    /**
+     * List of registered Group extensions.
+     *
+     * @see bp_register_group_extension()
+     *
+     * @since 10.0.0
+     * @var array
+     */
+    public $group_extensions = array();
 
     /**