Changeset 8754 for trunk/src/bp-friends/bp-friends-functions.php

Timestamp:

08/03/2014 08:52:05 PM (10 years ago)

Author:

djpaul

Message:

Activity: introducing @mentions auto-suggestions.

Activity has long-supported @mentions, where you can mention the name of another user to get their attention in a conversation. You've always had to know the exact username of the person you're trying to mention, or you've been forced to go look it up. Now, when leaving an activity update or reply, press @ and then start typing someone's diaply name (or user_nicename), and username suggestions will automatically appear below where you're typing.

If the Friends component is active, and if the logged-in user has any friends, those friends' details are used to pre-prime the username suggestions for super-fast snappy suggestions. Suggestions are also provided when writing a blog post comment.

This change has mostly been implemented using two third-party libraries, At.js (​https://github.com/ichord/At.js) and Caret.js (​https://github.com/ichord/Caret.js). Big thanks to those projects' authors for their fine work, and also to Automattic's O2 team, who made a number of CSS+JS tweaks/adaptions to At.js, which we've adopted. Props also to karmatosed for design suggestions on the earliest implementation of this feature, three years ago. :)

Fixes #3278

File:

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

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

@@ -567 +567 @@
 add_action( 'delete_user',       'friends_remove_data' );
 add_action( 'bp_make_spam_user', 'friends_remove_data' );
+
+/**
+ * Used by the Activity component's @mentions to print a JSON list of the current user's friends.
+ *
+ * This is intended to speed up @mentions lookups for a majority of use cases.
+ *
+ * @see bp_activity_mentions_script()
+ */
+function bp_friends_prime_mentions_results() {
+    if ( ! bp_activity_maybe_load_mentions_scripts() ) {
+        return;
+    }
+
+    $friends_query = array(
+        'count_total'     => '',                    // Prevents total count
+        'populate_extras' => false,
+
+        'type'            => 'alphabetical',
+        'user_id'         => get_current_user_id(),
+    );
+
+    $friends_query = new BP_User_Query( $friends_query );
+    $results       = array();
+
+    foreach ( $friends_query->results as $user ) {
+        $result        = new stdClass();
+        $result->ID    = $user->user_nicename;
+        $result->image = bp_core_fetch_avatar( array( 'html' => false, 'item_id' => $user->ID ) );
+        $result->name  = bp_core_get_user_displayname( $user->ID );
+
+        $results[] = $result;
+    }
+
+    wp_localize_script( 'bp-mentions', 'BP_Suggestions', array(
+        'friends' => $results,
+    ) );
+}
+add_action( 'bp_activity_mentions_prime_results', 'bp_friends_prime_mentions_results' );