bbp_get_form_forum_visibility_dropdown( $args = '' )

Return the forum visibility dropdown

Description

Parameters

$forum_id: (Required) The forum id to use

Return

(string) HTML select list for selecting forum visibility

Source

function bbp_get_form_forum_visibility_dropdown( $args = '' ) {
 
    // Backpat for handling passing of a forum ID
    if ( is_int( $args ) ) {
        $forum_id = (int) $args;
        $args     = array();
    } else {
        $forum_id = 0;
    }
 
    // Parse arguments against default values
    $r = bbp_parse_args( $args, array(
        'select_id'    => 'bbp_forum_visibility',
        'tab'          => bbp_get_tab_index(),
        'forum_id'     => $forum_id,
        'selected'     => false
    ), 'forum_type_select' );
 
    // No specific selected value passed
    if ( empty( $r['selected'] ) ) {
 
        // Post value is passed
        if ( bbp_is_post_request() && isset( $_POST[ $r['select_id'] ] ) ) {
            $r['selected'] = $_POST[ $r['select_id'] ];
 
        // No Post value was passed
        } else {
 
            // Edit topic
            if ( bbp_is_forum_edit() ) {
                $r['forum_id'] = bbp_get_forum_id( $r['forum_id'] );
                $r['selected'] = bbp_get_forum_visibility( $r['forum_id'] );
 
            // New topic
            } else {
                $r['selected'] = bbp_get_public_status_id();
            }
        }
    }
 
    // Used variables
    $tab = ! empty( $r['tab'] ) ? ' tabindex="' . (int) $r['tab'] . '"' : '';
 
    // Start an output buffer, we'll finish it after the select loop
    ob_start(); ?>
 
    <select name="<?php echo esc_attr( $r['select_id'] ) ?>" id="<?php echo esc_attr( $r['select_id'] ) ?>_select"<?php echo $tab; ?>>
 
        <?php foreach ( bbp_get_forum_visibilities() as $key => $label ) : ?>
 
            <option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $r['selected'] ); ?>><?php echo esc_html( $label ); ?></option>
 
        <?php endforeach; ?>
 
    </select>
 
    <?php
 
    // Return the results
    return apply_filters( 'bbp_get_form_forum_type_dropdown', ob_get_clean(), $r );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3563)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/functions.php: bbp_is_post_request()	Return true\|false if this is a POST request
bp-forums/core/functions.php: bbp_get_public_status_id()	Return the public post status ID
bp-forums/forums/template.php: bbp_get_forum_visibility()	Return the visibility of the forum
bp-forums/forums/template.php: bbp_get_forum_id()	Return the forum id
bp-forums/forums/functions.php: bbp_get_forum_visibilities()	Return an associative array of forum visibility
bp-forums/common/template.php: bbp_get_tab_index()	Output the current tab index of a given form
bp-forums/common/template.php: bbp_is_forum_edit()	Check if current page is a forum edit page
bp-forums/common/functions.php: bbp_parse_args()	Merge user defined arguments into defaults array.
bp-forums/functions.php: bbp_get_forum_group_ids()	Get group ID’s for a forum

Show 4 more uses Hide more uses

Used By
Used By	Description
bp-forums/forums/template.php: bbp_form_forum_visibility_dropdown()	Output value forum visibility dropdown

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