bp_is_root_blog( int $blog_id )

Is this the root blog?

Description

Parameters

$blog_id: (int) (Optional) Default: the ID of the current blog.

Return

(bool) $is_root_blog Returns true if this is bp_get_root_blog_id().

Source

function bp_is_root_blog( $blog_id = 0 ) {

	// Assume false.
	$is_root_blog = false;

	// Use current blog if no ID is passed.
	if ( empty( $blog_id ) || ! is_int( $blog_id ) ) {
		$blog_id = get_current_blog_id();
	}

	// Compare to root blog ID.
	if ( bp_get_root_blog_id() === $blog_id ) {
		$is_root_blog = true;
	}

	/**
	 * Filters whether or not we're on the root blog.
	 *
	 * @since BuddyPress 1.5.0
	 *
	 * @param bool $is_root_blog Whether or not we're on the root blog.
	 */
	return (bool) apply_filters( 'bp_is_root_blog', (bool) $is_root_blog );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.5.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-functions.php: bp_get_root_blog_id()	Get the ID of the root blog.
bp-core/bp-core-functions.php: bp_is_root_blog	Filters whether or not we’re on the root blog.

Used By
Used By	Description
bp-groups/bp-groups-functions.php: bp_group_get_count_by_group_type()	Get group count of group type tabs groups.
bp-core/classes/class-bp-admin.php: BP_Admin::bp_emails_add_sub_menu_page_admin_menu()
bp-forums/admin/admin.php: BBP_Admin::map_settings_meta_caps()	Maps settings capabilities
bp-blogs/bp-blogs-widgets.php: bp_blogs_register_widgets()	Register the widgets for the Blogs component.
bp-groups/bp-groups-functions.php: bp_get_group_ids_by_group_types()	Get group count of group type tabs groups.
bp-core/deprecated/buddyboss/1.1.8.php: bp_get_total_count_by_group_types()	Get group count of group type tabs groups.
bp-friends/bp-friends-widgets.php: bp_friends_register_widgets()	Register the friends widget.
bp-templates/bp-nouveau/includes/customizer.php: bp_nouveau_customize_register()	Add a specific panel for the BP Nouveau Template Pack.
bp-templates/bp-nouveau/buddypress-functions.php: BP_Nouveau::includes()	Includes!
bp-core/bp-core-taxonomy.php: bp_register_default_taxonomies()	Register our default taxonomies.
bp-core/admin/bp-core-admin-tools.php: bp_admin_reinstall_emails()	Delete emails and restore from defaults.
bp-core/admin/bp-core-admin-pages.php: bp_admin_setting_callback_page_directory_dropdown()	Pages drop downs callback
bp-core/admin/bp-core-admin-functions.php: bp_admin_wp_nav_menu_meta_box()	Register meta box and associated JS for BuddyPress WP Nav Menu.
bp-core/admin/bp-core-admin-functions.php: bp_core_print_admin_notices()	Print admin messages to admin_notices or network_admin_notices.
bp-core/admin/bp-core-admin-functions.php: bp_core_activation_notice()	Verify that some BP prerequisites are set up properly, and notify the admin if not.
bp-core/bp-core-customizer-email.php: bp_email_get_redirect_to_customizer_url()	Return a redirect url to the Customizer, previewing a randomly selected email.
bp-core/bp-core-update.php: bp_version_updater()	Initialize an update or installation of BuddyPress.
bp-core/deprecated/buddypress/2.1.php: bp_adminbar_authors_menu()	Add the Blog Authors menu to the BuddyBar (visible when not logged in).
bp-core/classes/class-bp-core.php: BP_Core::register_post_types()	Set up post types.
bp-core/bp-core-caps.php: bp_set_current_user_default_role()	Set a default role for the current user.
bp-core/bp-core-cssjs.php: bp_core_confirmation_js()	Load the JS for “Are you sure?” confirm links.
bp-core/bp-core-functions.php: bp_get_email()	Get an BP_Email object for the specified email type.
bp-core/bp-core-functions.php: bp_upload_dir()	Set data from the BP root blog’s upload directory.
bp-core/bp-core-functions.php: bp_core_add_page_mappings()	Creates necessary directory pages.
bp-core/bp-core-functions.php: bp_core_on_directory_page_delete()	Remove the entry from bp_pages when the corresponding WP page is deleted.
bp-core/bp-core-filters.php: bp_core_exclude_pages()	Prevent specific pages (eg ‘Activate’) from showing on page listings.
bp-core/bp-core-filters.php: bp_core_exclude_pages_from_nav_menu_admin()	Prevent specific pages (eg ‘Activate’) from showing in the Pages meta box of the Menu Administration screen.
bp-core/bp-core-filters.php: bp_core_login_redirect()	When a user logs in, redirect him in a logical way.
bp-core/bp-core-cache.php: bp_core_clear_directory_pages_cache_page_edit()	Clear the directory_pages cache when one of the pages is updated.
bp-core/bp-core-catchuri.php: bp_core_set_uri_globals()	Analyze the URI and break it down into BuddyPress-usable chunks.

Show 25 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