Changeset 9257 for trunk/src/bp-friends/bp-friends-activity.php

Timestamp:

12/22/2014 09:46:50 PM (11 years ago)

Author:

r-a-y

Message:

Activity: Support multiple scopes in bp_has_activities().

This commit:

• Allows the 'scope' parameter to support multiple scopes. For example, scope=friends,mentions. This can be a comma-delimited string or an array.
• Makes the 'scope' parameter available across the bp_has_activities() stack. Previously, 'scope' was only available for use in the bp_has_activities() loop.
• Parses scopes using the BP_Activity_Query class to handle complex conditions.
• Allows components to declare their own custom activity scopes. Components can also override existing activity arguments by setting the 'override' key in their scope callback. For an example, see how the friends component declares the 'friends' scope in bp_friends_filter_activity_scope(). Previously, it was not possible for components or third-party plugins to declare their own scopes without doing a fair bit of workarounds.

See #4988.

File:

• trunk/src/bp-friends/bp-friends-activity.php (modified) (1 diff)

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

@@ -229 +229 @@
 
 /**
+ * Set up activity arguments for use with the 'friends' scope.
+ *
+ * For details on the syntax, see {@link BP_Activity_Query}.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval Empty array by default
+ * @param array $filter Current activity arguments
+ * @return array
+ */
+function bp_friends_filter_activity_scope( $retval, $filter ) {
+    $friends = friends_get_friend_user_ids( $filter['user_id'] );
+
+    if ( empty( $friends ) ) {
+        return $retval;
+    }
+
+    $retval= array(
+        'relation' => 'AND',
+        array(
+            'column'  => 'user_id',
+            'compare' => 'IN',
+            'value'   => (array) $friends
+        ),
+        // we should only be able to view sitewide activity content for friends
+        array(
+            'column' => 'hide_sitewide',
+            'value'  => 0
+        ),
+    );
+
+    // wipe out the user ID
+    $retval['override']['filter']['user_id'] = 0;
+
+    // make sure we aren't limiting items by 'hide_sitewide' since we're already
+    // limiting it above
+    $scope_args['override']['show_hidden'] = true;
+
+    return $retval;
+}
+add_filter( 'bp_activity_set_friends_scope_args', 'bp_friends_filter_activity_scope', 10, 2 );
+
+/**
  * Add activity stream items when one members accepts another members request
  * for virtual friendship.