Changeset 9844 for trunk/src/bp-core/bp-core-template.php

Timestamp:

05/06/2015 11:01:27 PM (11 years ago)

Author:

r-a-y

Message:

Core: Introduce ability for components to register new features.

This commit allows plugin developers to register a feature in the
'BP_Component' class. To BuddyPress, a feature is merely an internal
marker. It is up to the developer to implement the feature.

Developers can check if a feature is registered with this snippet:

bp_is_active( $component, $feature_name )

See #6331 where this idea came about.

Props boonebgorges, imath, r-a-y.

File:

• trunk/src/bp-core/bp-core-template.php (modified) (2 diffs)

trunk/src/bp-core/bp-core-template.php

@@ -1846 +1846 @@
 
 /**
- * Check whether a given component has been activated by the admin.
+ * Check whether a given component (or feature of a component) is active.
+ *
+ * @since BuddyPress (1.2.0) See r2539.
+ * @since BuddyPress (2.3.0) Added $feature as a parameter.
  *
  * @param string $component The component name.
- * @return bool True if the component is active, otherwise false.
- */
-function bp_is_active( $component = '' ) {
+ * @param string $feature   The feature name.
+ * @return bool
+ */
+function bp_is_active( $component = '', $feature = '' ) {
     $retval = false;
 
@@ -1862 +1866 @@
     if ( isset( buddypress()->active_components[ $component ] ) || isset( buddypress()->required_components[ $component ] ) ) {
         $retval = true;
+
+        // Is feature active?
+        if ( ! empty( $feature ) ) {
+            if ( empty( buddypress()->$component->features ) || false === in_array( $feature, buddypress()->$component->features, true ) ) {
+                $retval = false;
+            }
+
+            /**
+             * Filters whether or not a given feature for a component is active.
+             *
+             * @since BuddyPress (2.3.0)
+             *
+             * @param bool $retval
+             */
+            $retval = apply_filters( "bp_is_{$component}_{$feature}_active", $retval );
+        }
     }