Contents

Code Reference Functions bbp_user_can_view_forum()

bbp_user_can_view_forum( $args = '' )

Check if the user can access a specific forum

Description

Return

(bool)

Source

File: bp-forums/users/template.php

1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
function bbp_user_can_view_forum( $args = '' ) {
 
    // Parse arguments against default values
    $r = bbp_parse_args( $args, array(
        'user_id'         => bbp_get_current_user_id(),
        'forum_id'        => bbp_get_forum_id(),
        'check_ancestors' => false
    ), 'user_can_view_forum' );
 
    // Validate parsed values
    $user_id  = bbp_get_user_id( $r['user_id'], false, false );
    $forum_id = bbp_get_forum_id( $r['forum_id'] );
    $retval   = false;
 
    // User is a keymaster
    if ( !empty( $user_id ) && bbp_is_user_keymaster( $user_id ) ) {
        $retval = true;
 
    // Forum is public, and user can read forums or is not logged in
    } elseif ( bbp_is_forum_public( $forum_id, $r['check_ancestors'] ) ) {
        $retval = true;
 
    // Forum is private, and user can see it
    } elseif ( bbp_is_forum_private( $forum_id, $r['check_ancestors'] ) && user_can( $user_id, 'read_private_forums' ) ) {
        $retval = true;
 
    // Forum is hidden, and user can see it
    } elseif ( bbp_is_forum_hidden ( $forum_id, $r['check_ancestors'] ) && user_can( $user_id, 'read_hidden_forums'  ) ) {
        $retval = true;
    }
 
    return apply_filters( 'bbp_user_can_view_forum', $retval, $forum_id, $user_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r3127) Introduced.

Uses

Uses
Uses Description
bp-forums/functions.php: bbp_forum_recursive_group_id()

Get Sub Forum’s group id, if not associated with any group then it searches for the parent forums to fetch group associated otherwise returns false
bp-forums/users/template.php: bbp_user_can_view_forum

For check Current topic’s forum is part of group or not.
bp-forums/users/capabilities.php: bbp_is_user_keymaster()

Checks if user is a keymaster
bp-forums/users/template.php: bbp_get_current_user_id()

Return ID of current user
bp-forums/users/template.php: bbp_get_user_id()

Return a validated user id
bp-forums/forums/template.php: bbp_is_forum_private()

Is the forum private?
bp-forums/forums/template.php: bbp_is_forum_hidden()

Is the forum hidden?
bp-forums/forums/template.php: bbp_is_forum_public()

Is the forum public?
bp-forums/forums/template.php: bbp_get_forum_id()

Return the forum id
bp-forums/common/functions.php: bbp_parse_args()

Merge user defined arguments into defaults array.
bp-groups/bp-groups-functions.php: groups_is_user_member()

Check whether a user is a member of a given group.
bp-core/bp-core-template.php: bp_is_active()

Check whether a given component (or feature of a component) is active.
Show 7 more uses Hide more uses
Used By
Used By Description
bp-document/bp-document-functions.php: bp_document_user_can_manage_document()

Check user have a permission to manage the document.
bp-media/bp-media-functions.php: bp_media_user_can_manage_media()

Check user have a permission to manage the media.
bp-forums/notifications.php: bbp_buddypress_add_topic_notification()

Hooked into the new topic function, this notification action is responsible for notifying topic.
bp-forums/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::can_access_content()

Check current access permission.
bp-forums/topics/functions.php: bbp_display_topics_feed_rss2()

Output an RSS2 feed of topics, based on the query passed.
bp-forums/notifications.php: bbp_buddypress_add_notification()

Hooked into the new reply function, this notification action is responsible for notifying topic and hierarchical reply authors of topic replies.
bp-forums/common/shortcodes.php: BBP_Shortcodes::display_forum()

Display the contents of a specific forum ID in an output buffer and return to ensure that post/page contents are displayed first.
bp-forums/common/shortcodes.php: BBP_Shortcodes::display_topic()

Display the contents of a specific topic ID in an output buffer and return to ensure that post/page contents are displayed first.
bp-forums/common/shortcodes.php: BBP_Shortcodes::display_topic_form()

Display the topic form in an output buffer and return to ensure post/page contents are displayed first.
bp-forums/common/shortcodes.php: BBP_Shortcodes::display_reply()

Display the contents of a specific reply ID in an output buffer and return to ensure that post/page contents are displayed first.
bp-forums/replies/functions.php: bbp_display_replies_feed_rss2()

Output an RSS2 feed of replies, based on the query passed.
Show 6 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.