bbp_is_user_favorite( int $user_id, int $topic_id )

Check if a topic is in user’s favorites or not

Description

Parameters

$user_id: (Optional) User id
$topic_id: (Optional) Topic id

Return

(bool) True if the topic is in user's favorites, otherwise false

Source

function bbp_is_user_favorite( $user_id = 0, $topic_id = 0 ) {
 
    $user_id = bbp_get_user_id( $user_id, true, true );
    if ( empty( $user_id ) )
        return false;
 
    $retval    = false;
    $favorites = bbp_get_user_favorites_topic_ids( $user_id );
 
    if ( !empty( $favorites ) ) {
 
        // Checking a specific topic id
        if ( !empty( $topic_id ) ) {
            $topic    = bbp_get_topic( $topic_id );
            $topic_id = !empty( $topic ) ? $topic->ID : 0;
 
        // Using the global topic id
        } elseif ( bbp_get_topic_id() ) {
            $topic_id = bbp_get_topic_id();
 
        // Use the current post id
        } elseif ( !bbp_get_topic_id() ) {
            $topic_id = get_the_ID();
        }
 
        // Is topic_id in the user's favorites
        if ( !empty( $topic_id ) ) {
            $retval = in_array( $topic_id, $favorites );
        }
    }
 
    return (bool) apply_filters( 'bbp_is_user_favorite', (bool) $retval, $user_id, $topic_id, $favorites );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2652)	Introduced.

Uses

Uses
Uses	Description
bp-forums/topics/template.php: bbp_get_topic()	Gets a topic
bp-forums/topics/template.php: bbp_get_topic_id()	Return the topic id
bp-forums/users/template.php: bbp_get_user_id()	Return a validated user id
bp-forums/users/functions.php: bbp_get_user_favorites_topic_ids()	Get a user’s favorite topics’ ids

Used By
Used By	Description
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::get_topic_action_states()	Get topic actions state based on current user.
bp-forums/classes/class-bp-rest-topics-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::rest_update_favorite()	Update favourites for the topic.
bp-forums/templates/default/bbpress-functions.php: BBP_Default::ajax_favorite()	AJAX handler to add or remove a topic from a user’s favorites
bp-forums/users/template.php: bbp_get_user_favorites_link()	User favorites link
bp-forums/users/functions.php: bbp_favorites_handler()	Handles the front end adding and removing of favorite topics

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