bbp_forum_subscriptions_handler( string $action = '' )

Handles the front end subscribing and unsubscribing forums

Description

Parameters

$action

(Optional) The requested action to compare this function to

Default value: ''

Source

function bbp_forum_subscriptions_handler( $action = '' ) {
 
    if ( ! bbp_is_subscriptions_active() ) {
        return false;
    }
 
    // Bail if no forum ID is passed
    if ( empty( $_GET['forum_id'] ) ) {
        return;
    }
 
    // Setup possible get actions
    $possible_actions = array(
        'bbp_subscribe',
        'bbp_unsubscribe',
    );
 
    // Bail if actions aren't meant for this function
    if ( ! in_array( $action, $possible_actions ) ) {
        return;
    }
 
    // Get required data
    $user_id  = bbp_get_user_id( 0, true, true );
    $forum_id = intval( $_GET['forum_id'] );
 
    // Check for empty forum
    if ( empty( $forum_id ) ) {
        bbp_add_error( 'bbp_subscription_forum_id', __( '<strong>ERROR</strong>: No forum was found! Which forum are you subscribing/unsubscribing to?', 'buddyboss' ) );
 
    // Check nonce
    } elseif ( ! bbp_verify_nonce_request( 'toggle-subscription_' . $forum_id ) ) {
        bbp_add_error( 'bbp_subscription_forum_id', __( '<strong>ERROR</strong>: Are you sure you wanted to do that?', 'buddyboss' ) );
 
    // Check current user's ability to edit the user
    } elseif ( !current_user_can( 'edit_user', $user_id ) ) {
        bbp_add_error( 'bbp_subscription_permissions', __( '<strong>ERROR</strong>: You don\'t have the permission to edit favorites of that user!', 'buddyboss' ) );
    }
 
    // Bail if we have errors
    if ( bbp_has_errors() ) {
        return;
    }
 
    /** No errors *************************************************************/
 
    $is_subscription = bbp_is_user_subscribed( $user_id, $forum_id );
    $success         = false;
 
    if ( true === $is_subscription && 'bbp_unsubscribe' === $action ) {
        $success = bbp_remove_user_subscription( $user_id, $forum_id );
    } elseif ( false === $is_subscription && 'bbp_subscribe' === $action ) {
        $success = bbp_add_user_subscription( $user_id, $forum_id );
    }
 
    // Do additional subscriptions actions
    do_action( 'bbp_subscriptions_handler', $success, $user_id, $forum_id, $action );
 
    // Success!
    if ( true === $success ) {
 
        // Redirect back from whence we came
        if ( bbp_is_subscriptions() ) {
            $redirect = bbp_get_subscriptions_permalink( $user_id );
        } elseif ( bbp_is_single_user() ) {
            $redirect = bbp_get_user_profile_url();
        } elseif ( is_singular( bbp_get_forum_post_type() ) ) {
            $redirect = bbp_get_forum_permalink( $forum_id );
        } elseif ( is_single() || is_page() ) {
            $redirect = get_permalink();
        } else {
            $redirect = get_permalink( $forum_id );
        }
 
        wp_safe_redirect( $redirect );
 
        // For good measure
        exit();
 
    // Fail! Handle errors
    } elseif ( true === $is_subscription && 'bbp_unsubscribe' === $action ) {
        bbp_add_error( 'bbp_unsubscribe', __( '<strong>ERROR</strong>: There was a problem unsubscribing from that forum!', 'buddyboss' ) );
    } elseif ( false === $is_subscription && 'bbp_subscribe' === $action ) {
        bbp_add_error( 'bbp_subscribe',    __( '<strong>ERROR</strong>: There was a problem subscribing to that forum!', 'buddyboss' ) );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r5156)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/functions.php: bbp_add_error()	Adds an error message to later be output in the theme
bp-forums/core/functions.php: bbp_has_errors()	Check if error messages exist in queue
bp-forums/core/options.php: bbp_is_subscriptions_active()	Checks if subscription feature is enabled.
bp-forums/users/template.php: bbp_get_subscriptions_permalink()	Return the link to the user’s subscriptions page (profile page)
bp-forums/users/template.php: bbp_get_user_profile_url()	Return URL to the profile page of a user
bp-forums/users/template.php: bbp_get_user_id()	Return a validated user id
bp-forums/users/functions.php: bbp_subscriptions_handler	No errors
bp-forums/users/functions.php: bbp_is_user_subscribed()	Check if a topic or forum is in user’s subscription list or not
bp-forums/users/functions.php: bbp_remove_user_subscription()	Remove a topic from user’s subscriptions
bp-forums/users/functions.php: bbp_add_user_subscription()	Add a topic to user’s subscriptions
bp-forums/forums/template.php: bbp_get_forum_permalink()	Return the link to the forum
bp-forums/forums/template.php: bbp_get_forum_post_type()	Return the unique id of the custom post type for forums
bp-forums/common/template.php: bbp_is_single_user()	Check if current page is a user profile page
bp-forums/common/template.php: bbp_is_subscriptions()	Check if current page is a Forums user’s subscriptions page (profile page)
bp-forums/common/functions.php: bbp_verify_nonce_request()	Makes sure the user requested an action from another page on this site.

Show 10 more uses Hide more uses

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