bp_activity_total_favorites_for_user( int $user_id )

Retrieve the number of favorite activity feed items a user has.

Description

Parameters

$user_id: (Required) ID of the user whose favorite count is being requested.

Return

(int) Total favorite count for the user.

Source

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

function bp_activity_total_favorites_for_user( $user_id = 0 ) {
 
    // Fallback on displayed user, and then logged in user.
    if ( empty( $user_id ) ) {
        $user_id = ( bp_displayed_user_id() ) ? bp_displayed_user_id() : bp_loggedin_user_id();
    }
 
    return BP_Activity_Activity::total_favorite_count( $user_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.2.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.
bp-core/bp-core-template.php: bp_displayed_user_id()	Get the ID of the currently displayed user.
bp-activity/classes/class-bp-activity-activity.php: BP_Activity_Activity::total_favorite_count()	Get favorite count for a given user.

Used By
Used By	Description
bp-activity/bp-activity-template.php: bp_get_total_favorite_count_for_user()	Return the total favorite count for a specified user.

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.

Contents