Contents

Code Reference Functions bp_activity_find_mentions()

bp_activity_find_mentions( string $content )

Find mentioned users from activity content

Description

Parameters

$content

(Required) The content of the activity, usually found in $activity->content.

Return

(array|bool) Associative array with user ID as key and username as value. Boolean false if no mentions found.

Source

File: bp-activity/bp-activity-functions.php

90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
function bp_activity_find_mentions( $content ) {
 
    $pattern = '/[@]+([A-Za-z0-9-_\.@]+)\b/';
    preg_match_all( $pattern, $content, $usernames );
 
    // Make sure there's only one instance of each username.
    $usernames = array_unique( $usernames[1] );
 
    // Bail if no usernames.
    if ( empty( $usernames ) ) {
        return false;
    }
 
    $mentioned_users = array();
 
    // We've found some mentions! Check to see if users exist.
    foreach( (array) array_values( $usernames ) as $username ) {
        $user_id = bp_activity_get_userid_from_mentionname( $username );
 
        // The user ID exists, so let's add it to our array.
        if ( ! empty( $user_id ) ) {
            $mentioned_users[ $user_id ] = $username;
        }
    }
 
    if ( empty( $mentioned_users ) ) {
        return false;
    }
 
    /**
     * Filters the mentioned users.
     *
     * @since BuddyPress 2.5.0
     *
     * @param array $mentioned_users Associative array with user IDs as keys and usernames as values.
     */
    return apply_filters( 'bp_activity_mentioned_users', $mentioned_users );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.5.0 Introduced.
Used By
Used By Description
bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::extract_mentions()

Extract @mentions tags from text.
bp-activity/bp-activity-functions.php: bp_activity_format_activity_action_activity_update()

Format ‘activity_update’ activity actions.
bp-activity/bp-activity-functions.php: bp_activity_adjust_mention_count()

Adjusts mention count for mentioned users in activity items.
bp-activity/bp-activity-filters.php: bp_activity_at_name_filter()

Find and link @-mentioned users in the contents of a given item.
bp-activity/bp-activity-filters.php: bp_activity_at_name_filter_updates()

Catch mentions in an activity item before it is saved into the database.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.