bp_core_get_root_option( string $option )

Get a root option.

Description

"Root options" are those that apply across an entire installation, and are fetched only a single time during a pageload and stored in buddypress()->site_options to prevent future lookups. See bp_core_get_root_options().

Parameters

$option: (Required) Name of the option key.

Return

(mixed) Value, if found.

Source

File: bp-core/bp-core-options.php

function bp_core_get_root_option( $option ) {
    $bp = buddypress();
 
    if ( ! isset( $bp->site_options ) ) {
        $bp->site_options = bp_core_get_root_options();
    }
 
    $value = '';
    if ( isset( $bp->site_options[ $option ] ) ) {
        $value = $bp->site_options[ $option ];
    }
 
    return $value;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.3.0	Introduced.

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-core/bp-core-options.php: bp_core_get_root_options()	Fetch global BP options.

Used By
Used By	Description
bp-members/classes/class-bp-rest-members-details-endpoint.php: BP_REST_Members_Details_Endpoint::bp_rest_default_menu()	Get default dropdown navigation.
bp-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::create_item()	Create signup.
bp-activity/classes/class-bp-rest-activity-endpoint.php: BP_REST_Activity_Endpoint::prepare_item_for_response()	Prepares activity data for return as an object.
bp-settings/classes/class-bp-settings-component.php: BP_Settings_Component::setup_admin_bar()	Set up the Toolbar.
bp-blogs/bp-blogs-filters.php: bp_blogs_post_pre_publish()	Check whether the current activity about a post or a comment can be published.
bp-xprofile/classes/class-bp-xprofile-user-admin.php: BP_XProfile_User_Admin::user_admin_avatar_metabox()	Render the Avatar metabox to moderate inappropriate images.
bp-xprofile/classes/class-bp-xprofile-user-admin.php: BP_XProfile_User_Admin::enqueue_scripts()	Enqueue needed scripts.
bp-xprofile/classes/class-bp-xprofile-component.php: BP_XProfile_Component::setup_globals()	Setup globals.
bp-members/screens/register.php: bp_core_screen_signup()	Handle the loading of the signup screen.
bp-core/bp-core-template.php: bp_get_blog_signup_allowed()	Is blog signup allowed?
bp-core/bp-core-attachments.php: bp_attachments_get_max_upload_file_size()	Get the max upload file size for any attachment.
bp-core/bp-core-avatars.php: bp_avatar_is_front_edit()	Checks whether Avatar UI should be loaded.
bp-activity/classes/class-bp-activity-template.php: BP_Activity_Template::__construct()	Constructor method.

Show 8 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.

Contents