bbp_hide_forum( int $forum_id,  $current_visibility = '' )

Mark the forum as hidden

Description

Parameters

$forum_id

(Optional) Forum id

Return

(bool) False on failure, true on success

Source

File: bp-forums/forums/functions.php

906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
function bbp_hide_forum( $forum_id = 0, $current_visibility = '' ) {
 
    $forum_id = bbp_get_forum_id( $forum_id );
 
    do_action( 'bbp_hide_forum', $forum_id );
 
    // Only run queries if visibility is changing
    if ( bbp_get_hidden_status_id() !== $current_visibility ) {
 
        // Get private forums
        $private = bbp_get_private_forum_ids();
 
        // Find this forum in the array
        if ( in_array( $forum_id, $private ) ) {
 
            $offset = array_search( $forum_id, $private );
 
            // Splice around it
            array_splice( $private, $offset, 1 );
 
            // Update private forums minus this one
            update_option( '_bbp_private_forums', array_unique( array_filter( array_values( $private ) ) ) );
        }
 
        // Add to '_bbp_hidden_forums' site option
        $hidden   = bbp_get_hidden_forum_ids();
        $hidden[] = $forum_id;
        update_option( '_bbp_hidden_forums', array_unique( array_filter( array_values( $hidden ) ) ) );
 
        // Update forums visibility setting
        global $wpdb;
        $wpdb->update( $wpdb->posts, array( 'post_status' => bbp_get_hidden_status_id() ), array( 'ID' => $forum_id ) );
        wp_transition_post_status( bbp_get_hidden_status_id(), $current_visibility, get_post( $forum_id ) );
        bbp_clean_post_cache( $forum_id );
    }
 
    do_action( 'bbp_hid_forum'$forum_id );
 
    return $forum_id;
}

Changelog

Changelog
Version Description
bbPress (r2996) Introduced.

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.