Changeset 4602 for trunk/bp-core/bp-core-functions.php

Timestamp:

07/04/2011 04:59:01 PM (14 years ago)

Author:

johnjamesjacoby

Message:

• Swap BP_ROOT_BLOG const usage for new bp_get_root_blog_id() function
• Use bp_get_root_blog_id() place of bp_get_option_blog_id()
• Check for BP_ENABLE_MULTIBLOG when assigning root blog ID

See #3313, #3314.

File:

• trunk/bp-core/bp-core-functions.php (modified) (10 diffs)

trunk/bp-core/bp-core-functions.php

@@ -12 +12 @@
  * @since 1.3
  *
- * @uses bp_get_option_blog_id()
+ * @uses bp_get_root_blog_id()
  * @param str $option_name The option to be retrieved
  * @param str $default Optional. Default value to be returned if the option isn't set
@@ -18 +18 @@
  */
 function bp_get_option( $option_name, $default = '' ) {
-    $value = get_blog_option( bp_get_option_blog_id( $option_name ), $option_name, $default );
+    $value = get_blog_option( bp_get_root_blog_id(), $option_name, $default );
     
     return apply_filters( 'bp_get_option', $value );
@@ -32 +32 @@
  * @since 1.3
  *
- * @uses bp_get_option_blog_id()
+ * @uses bp_get_root_blog_id()
  * @param str $option_name The option key to be set
  * @param str $value The value to be set
  */
 function bp_update_option( $option_name, $value ) {
-    // update_blog_option() does not return anything on success/failure, so neither can we
-    update_blog_option( bp_get_option_blog_id( $option_name ), $option_name, $value );
+    update_blog_option( bp_get_root_blog_id(), $option_name, $value );
 }
 
@@ -50 +49 @@
  * @since 1.3
  *
- * @uses bp_get_option_blog_id()
+ * @uses bp_get_root_blog_id()
  * @param str $option_name The option key to be set
  */
 function bp_delete_option( $option_name ) {
-    // update_blog_option() does not return anything on success/failure, so neither can we
-    delete_blog_option( bp_get_option_blog_id( $option_name ), $option_name );
-}
-
-/**
- * Retrieve the filterable blog_id of the blog where the option is question is saved
- *
- * Since BP 1.3, BuddyPress has stored all of its settings in blog options tables, as opposed to
- * sitemeta. This makes it easier for non-standard setups (like BP_ENABLE_MULTIBLOG and
- * multinetwork BP) to save and access options in a consistent and logical way.
- *
- * By default, nearly all settings are stored in the options table of BP_ROOT_BLOG. The one
- * exception is when BP_ENABLE_MULTIBLOG is enabled. In this case, bp-pages - the list of pages that
- * are associated with BP top-level components - must be specific to each blog in the network. If
- * you are building a plugin that requires an option (either a BP-native option, or your own custom
- * option) to be specific to each blog in a network, filter 'bp_blog_specific_options' and add your
- * option's name. This will allow you to use bp_get_option() and bp_update_option() seamlessly.
- *
- * @package BuddyPress
- * @since 1.3
- *
- * @see bp_get_option()
- * @see bp_update_option()
- * @uses apply_filters() Filter bp_get_option_blog_id to change this setting
- * @return int $blog_id
- */
-function bp_get_option_blog_id( $option_name ) {
-    $blog_specific_options = apply_filters( 'bp_blog_specific_options', array(
-        'bp-pages'
-    ) );
-    
-    if ( in_array( $option_name, $blog_specific_options ) ) {
-        if ( defined( 'BP_ENABLE_MULTIBLOG' ) && BP_ENABLE_MULTIBLOG ) {
-            $blog_id = get_current_blog_id();
-        } else {
-            $blog_id = BP_ROOT_BLOG;
-        }
-    } else {
-        $blog_id = BP_ROOT_BLOG;
-    }
-
-    return apply_filters( 'bp_get_option_blog_id', $blog_id );
+    delete_blog_option( bp_get_root_blog_id(), $option_name );
 }
 
@@ -126 +84 @@
         $is_enable_multiblog = is_multisite() && defined( 'BP_ENABLE_MULTIBLOG' ) && BP_ENABLE_MULTIBLOG ? true : false;
   
-        $page_blog_id = $is_enable_multiblog ? get_current_blog_id() : BP_ROOT_BLOG;
+        $page_blog_id = $is_enable_multiblog ? get_current_blog_id() : bp_get_root_blog_id();
 
         if ( isset( $ms_page_ids[$page_blog_id] ) ) {
@@ -142 +100 @@
  *
  * bp-pages data is stored in site_options (falls back to options on non-MS), in an array keyed by
- * blog_id. This allows you to change your BP_ROOT_BLOG and go through the setup process again.
+ * blog_id. This allows you to change your bp_get_root_blog_id() and go through the setup process again.
  *
  * @package BuddyPress Core
@@ -170 +128 @@
     if ( $page_ids = bp_core_get_page_meta() ) {
 
-        $posts_table_name = is_multisite() && !defined( 'BP_ENABLE_MULTIBLOG' ) ? $wpdb->get_blog_prefix( BP_ROOT_BLOG ) . 'posts' : $wpdb->posts;
+        $posts_table_name = is_multisite() && !defined( 'BP_ENABLE_MULTIBLOG' ) ? $wpdb->get_blog_prefix( bp_get_root_blog_id() ) . 'posts' : $wpdb->posts;
         $page_ids_sql     = implode( ',', (array)$page_ids );
         $page_names       = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_name, post_parent, post_title FROM {$posts_table_name} WHERE ID IN ({$page_ids_sql}) AND post_status = 'publish' " ) );
@@ -513 +471 @@
     global $wpdb;
 
-    if ( defined( 'BP_ENABLE_MULTIBLOG' ) )
-        $domain = get_home_url( $wpdb->blogid );
-    else
-        $domain = get_home_url( BP_ROOT_BLOG );
+    $domain = get_home_url( bp_get_root_blog_id() );
 
     return apply_filters( 'bp_core_get_root_domain', $domain );
@@ -1097 +1052 @@
 
 /**
- * Is this BP_ROOT_BLOG?
+ * Is this the root blog ID?
  *
  * @package BuddyPress
@@ -1103 +1058 @@
  *
  * @param int $blog_id Optional. Defaults to the current blog id.
- * @return bool $is_root_blog Returns true if this is BP_ROOT_BLOG.
- */
-function bp_is_root_blog( $blog_id = false ) {
-    $is_root_blog = true;
-
-    if ( !$blog_id )
+ * @return bool $is_root_blog Returns true if this is bp_get_root_blog_id().
+ */
+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 ) )
         $blog_id = get_current_blog_id();
 
-    if ( $blog_id != BP_ROOT_BLOG )
-        $is_root_blog = false;
-
-    return apply_filters( 'bp_is_root_blog', $is_root_blog );
+    // Compare to root blog ID
+    if ( $blog_id == bp_get_root_blog_id() )
+        $is_root_blog = true;
+
+    return apply_filters( 'bp_is_root_blog', (bool) $is_root_blog );
+}
+
+/**
+ * Is this bp_get_root_blog_id()?
+ *
+ * @package BuddyPress
+ * @since 1.3
+ *
+ * @param int $blog_id Optional. Defaults to the current blog id.
+ * @return bool $is_root_blog Returns true if this is bp_get_root_blog_id().
+ */
+function bp_get_root_blog_id( $blog_id = false ) {
+
+    // Define on which blog ID BuddyPress should run
+    if ( !defined( 'BP_ROOT_BLOG' ) ) {
+
+        // Root blog is the main site on this network
+        if ( is_multisite() && !defined( 'BP_ENABLE_MULTIBLOG' ) ) {
+            $current_site = get_current_site();
+            $root_blog_id = $current_site->blog_id;
+
+        // Root blog is every site on this network
+        } elseif ( is_multisite() && defined( 'BP_ENABLE_MULTIBLOG' ) ) {
+            $root_blog_id = get_current_blog_id();
+
+        // Root blog is the only blog on this network
+        } elseif( !is_multisite() ) {
+            $root_blog_id = 1;
+        }
+
+        define( 'BP_ROOT_BLOG', $root_blog_id );
+        
+    // Root blog is defined
+    } else {
+        $root_blog_id = BP_ROOT_BLOG;
+    }
+
+    return apply_filters( 'bp_get_root_blog_id', (int) $root_blog_id );
 }