Changeset 8557 for trunk/src/bp-core/bp-core-functions.php

Timestamp:

07/03/2014 08:02:18 PM (10 years ago)

Author:

djpaul

Message:

at-mentions: overhaul the mentions implementation for Private Messages and Groups (admin) components.

Previously, these components had seperate implementations of username auto-suggestions, which weren't
reusable outside of where they'd been built, nor easily extended by developers, or other plugins.
This change creates a central API for auto-suggestions, currently only for usernames, but easily
extensible for other kinds of auto-suggestions in the future (i.e. group names, or #hashtags).

See #3278

File:

• trunk/src/bp-core/bp-core-functions.php (modified) (1 diff)

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

@@ -1922 +1922 @@
     return $nav_item_url;
 }
+
+/** Suggestions***************************************************************/
+
+/**
+ * BuddyPress Suggestions API for types of at-mentions.
+ *
+ * This is used to power BuddyPress' at-mentions suggestions, but it is flexible enough to be used
+ * for similar kinds of future requirements, or those implemented by third-party developers.
+ *
+ * @param array $args
+ * @return array|WP_Error Array of results. If there were any problems, returns a WP_Error object.
+ * @since BuddyPress (2.1.0)
+ */
+function bp_core_get_suggestions( $args ) {
+    $args = wp_parse_args( $args );
+
+    if ( ! $args['type'] ) {
+        return new WP_Error( 'missing_parameter' );
+    }
+
+    // Members @name suggestions.
+    if ( $args['type'] === 'members' ) {
+        $class = 'BP_Members_Suggestions';
+
+        // Members @name suggestions for users in a specific Group.
+        if ( isset( $args['group_id'] ) ) {
+            $class = 'BP_Groups_Member_Suggestions';
+        }
+
+    } else {
+        // If you've built a custom suggestions service, use this to tell BP the name of your class.
+        $class = apply_filters( 'bp_suggestions_services', '', $args );
+    }
+
+    if ( ! $class || ! class_exists( $class ) ) {
+        return new WP_Error( 'missing_parameter' );
+    }
+
+
+    $suggestions = new $class( $args );
+    $validation  = $suggestions->validate();
+
+    if ( is_wp_error( $validation ) ) {
+        $retval = $validation;
+    } else {
+        $retval = $suggestions->get_suggestions();
+    }
+
+    return apply_filters( 'bp_core_get_suggestions', $retval, $args );
+}