BP_REST_Forums_Endpoint::get_forum_action_states( int $forum_id )

Get forum action states based on current user.

Description

Parameters

$forum_id: (Required) ID of the forum.

Return

(array|void)

Source

File: bp-forums/classes/class-bp-rest-forums-endpoint.php

public function get_forum_action_states( $forum_id ) {
    if ( empty( $forum_id ) ) {
        return;
    }
 
    $forum_id = (int) $forum_id;
    $user_id  = bbp_get_user_id( 0, true, true );
 
    $state = array(
        'subscribed' => false,
    );
 
    if ( bbp_is_subscriptions_active() && current_user_can( 'edit_user', $user_id ) ) {
        $state['subscribed'] = bbp_is_user_subscribed( $user_id, $forum_id );
    }
 
    return $state;
}

Expand full source code Collapse full source code

Uses

Uses
Uses	Description
bp-forums/core/options.php: bbp_is_subscriptions_active()	Checks if subscription feature is enabled.
bp-forums/users/template.php: bbp_get_user_id()	Return a validated user id
bp-forums/users/functions.php: bbp_is_user_subscribed()	Check if a topic or forum is in user’s subscription list or not

Used By
Used By	Description
bp-forums/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::prepare_item_for_response()	Prepares component data for return as an object.

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