bbp_remove_user_favorite( int $user_id, int $topic_id )
Remove a topic from user’s favorites
Description Description
Parameters Parameters
- $user_id
-
(Optional) User id
- $topic_id
-
(Optional) Topic id
Return Return
(bool) True if the topic was removed from user's favorites, otherwise false
Source Source
File: includes/users/engagements.php
function bbp_remove_user_favorite( $user_id, $topic_id ) { $user_id = bbp_get_user_id( $user_id, false, false ); $topic_id = bbp_get_topic_id( $topic_id ); // Bail if not enough info if ( empty( $user_id ) || empty( $topic_id ) ) { return false; } // Bail if not already a favorite if ( ! bbp_is_user_favorite( $user_id, $topic_id ) ) { return false; } // Bail if remove fails if ( ! bbp_remove_user_from_object( $topic_id, $user_id, '_bbp_favorite' ) ) { return false; } do_action( 'bbp_remove_user_favorite', $user_id, $topic_id ); return true; }
Changelog Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |