bbp_remove_user_favorite( int $user_id, int $topic_id )

Remove a topic from user’s favorites

Description

Parameters

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

Return

(bool) True if the topic was removed from user's favorites, otherwise false

Source

function bbp_remove_user_favorite( $user_id, $topic_id ) {
    if ( empty( $user_id ) || empty( $topic_id ) )
        return false;
 
    $favorites = (array) bbp_get_user_favorites_topic_ids( $user_id );
    if ( empty( $favorites ) )
        return false;
 
    $pos = array_search( $topic_id, $favorites );
    if ( is_numeric( $pos ) ) {
        array_splice( $favorites, $pos, 1 );
        $favorites = array_filter( $favorites );
 
        if ( !empty( $favorites ) ) {
            $favorites = implode( ',', wp_parse_id_list( $favorites ) );
            update_user_option( $user_id, '_bbp_favorites', $favorites );
        } else {
            delete_user_option( $user_id, '_bbp_favorites' );
        }
    }
 
    do_action( 'bbp_remove_user_favorite', $user_id, $topic_id );
 
    return true;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2652)	Introduced.

Uses

Uses
Uses	Description
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-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::merge_item()	Merge Topic
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/topics/functions.php: bbp_remove_topic_from_all_favorites()	Remove a deleted topic from all users’ favorites
bp-forums/topics/functions.php: bbp_merge_topic_handler()	Merge topic handler
bp-forums/users/functions.php: bbp_favorites_handler()	Handles the front end adding and removing of favorite topics

Show 1 more used by Hide more used by

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