Changeset 13215 for trunk/src/bp-activity/bp-activity-functions.php

Timestamp:

01/19/2022 09:21:45 PM (3 years ago)

Author:

imath

Message:

Make it possible to disable Avatar history & richer logging activities

Advanced users wishing to:

1. disable the Avatar history feature, can do so returning true when filtering 'bp_disable_avatar_history',
2. prevent one or more logging activity types to have a richer output, can return an array of the allowed activity types (or an empty array to completely disable the feature) when filtering 'bp_activity_get_types_supporting_generated_content'.

Props sbrajesh, oztaser

Fixes #8617

File:

• trunk/src/bp-activity/bp-activity-functions.php (modified) (2 diffs)

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

@@ -633 +633 @@
 
 /**
+ * Gets the list of activity types name supporting the requested feature.
+ *
+ * This function is still a WIP, please don't use it into your plugins or themes.
+ *
+ * @since 10.0.0
+ *
+ * @access private
+ * @todo `bp_activity_set_action()` should be improved to include a supports
+ * argument or best we should create a `bp_register_activity_type()` function
+ * to mimic the way WordPress registers post types. For now we'll use a non
+ * extendable workaround.
+ *
+ * @param string $feature The feature activity types should support.
+ * @return array          The list of activity types name supporting the requested feature.
+ */
+function _bp_activity_get_types_by_support( $feature = 'generated-content' ) {
+    $activity_types = array();
+
+    if ( 'generated-content' === $feature ) {
+        $activity_types = array( 'new_member', 'new_avatar' );
+
+        if ( bp_is_active( 'friends' ) ) {
+            array_push( $activity_types, 'friendship_created' );
+        }
+
+        if ( bp_is_active( 'groups' ) ) {
+            array_push( $activity_types, 'created_group', 'joined_group' );
+        }
+
+        if ( bp_is_active( 'xprofile' ) ) {
+            array_push( $activity_types, 'updated_profile' );
+        }
+    }
+
+    $filter_key = str_replace( '-', '_', $feature );
+
+    /**
+     * Use this filter to add/remove activity types supporting the requested feature.
+     *
+     * The dynamic portion of the filter is the name of the requested feature where hyphens are
+     * replaced by underscores. Eg. use `bp_activity_get_types_supporting_generated_content` to
+     * edit the list of activities supporting the `generated-content` feature.
+     *
+     * @since 10.0.0
+     *
+     * @param array $activity_types The list of activity types name supporting the requested feature.
+     */
+    return apply_filters( "bp_activity_get_types_supporting_{$filter_key}", $activity_types );
+}
+
+/**
  * Check if the *Post Type* activity supports a specific feature.
  *
@@ -715 +766 @@
          */
         case 'generated-content' :
-            /*
-             * @todo `bp_activity_set_action()` should be improved to include a supports
-             * argument or best we should create a `bp_register_activity_type()` function
-             * to mimic the way WordPress registers post types. For now we'll use a non
-             * extendable workaround.
-             */
-            $activity_types = array( 'new_member', 'new_avatar' );
-
-            if ( bp_is_active( 'friends' ) ) {
-                array_push( $activity_types, 'friendship_created' );
-            }
-
-            if ( bp_is_active( 'groups' ) ) {
-                array_push( $activity_types, 'created_group', 'joined_group' );
-            }
-
-            if ( bp_is_active( 'xprofile' ) ) {
-                array_push( $activity_types, 'updated_profile' );
-            }
+            $activity_types = _bp_activity_get_types_by_support( 'generated-content' );
 
             $retval = in_array( $activity_type, $activity_types, true );