bp_activity_get_user_favorites( int $user_id )
Get a users favorite activity stream items.
Description Description
Parameters Parameters
- $user_id
-
(Required) ID of the user whose favorites are being queried.
Return Return
(array) IDs of the user's favorite activity items.
Source Source
File: bp-activity/bp-activity-functions.php
function bp_activity_get_user_favorites( $user_id = 0 ) {
// Fallback to logged in user if no user_id is passed.
if ( empty( $user_id ) ) {
$user_id = bp_displayed_user_id();
}
// Get favorites for user.
$favs = bp_get_user_meta( $user_id, 'bp_favorite_activities', true );
/**
* Filters the favorited activity items for a specified user.
*
* @since 1.2.0
*
* @param array $favs Array of user's favorited activity items.
*/
return apply_filters( 'bp_activity_get_user_favorites', $favs );
}
Changelog Changelog
| Version | Description |
|---|---|
| 1.2.0 | Introduced. |