bbp_get_form_option( string $option, string $default = '', bool $slug = false )

Return settings API option

Description

Parameters

$option

(Required)

$default

(Optional)

Default value: ''

$slug

(Optional)

Default value: false

Source

File: bp-forums/admin/settings.php

function bbp_get_form_option( $option, $default = '', $slug = false ) {
 
    // Get the option and sanitize it
    $value = get_option( $option, $default );
 
    // Slug?
    if ( true === $slug ) {
        $value = esc_attr( apply_filters( 'editable_slug', $value ) );
 
    // Not a slug
    } else {
        $value = esc_attr( $value );
    }
 
    // Fallback to default
    if ( empty( $value ) )
        $value = $default;
 
    // Allow plugins to further filter the output
    return apply_filters( 'bbp_get_form_option', $value, $option );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3203)	Introduced.

Uses

Uses
Uses	Description
bp-core/admin/bp-core-admin-settings.php: editable_slug	Filters the slug value in the form field.

Used By
Used By	Description
bp-forums/admin/settings.php: bbp_form_slug_conflict_check()	Used to check if a Forums slug conflicts with an existing known slug.
bp-forums/admin/settings.php: bbp_form_option()	Output settings API option

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