Changeset 9698

Timestamp:

04/05/2015 06:18:13 PM (10 years ago)

Author:

boonebgorges

Message:

Introduce bp_core_get_root_option() and use throughout BP.

Previously, we referenced the $bp->site_options array directly. This causes
problems in cases where these options may be referenced before the array is
initially populated. bp_core_get_root_option() will fetch the requested
value from the array if it's been populated, and will populate it if it has not.

Fixes #6045.

Location:

trunk

Files:

• src/bp-activity/bp-activity-template.php (modified) (1 diff)
• src/bp-blogs/bp-blogs-filters.php (modified) (1 diff)
• src/bp-core/bp-core-avatars.php (modified) (1 diff)
• src/bp-core/bp-core-options.php (modified) (1 diff)
• src/bp-core/bp-core-template.php (modified) (1 diff)
• src/bp-forums/bp-forums-loader.php (modified) (1 diff)
• src/bp-groups/bp-groups-loader.php (modified) (1 diff)
• src/bp-members/bp-members-screens.php (modified) (2 diffs)
• src/bp-members/bp-members-template.php (modified) (1 diff)
• src/bp-settings/bp-settings-loader.php (modified) (1 diff)
• src/bp-xprofile/bp-xprofile-loader.php (modified) (1 diff)
• tests/phpunit/testcases/core/functions.php (modified) (1 diff)

trunk/src/bp-activity/bp-activity-template.php

@@ -296 +296 @@
 
         // Check if blog/forum replies are disabled
-        $this->disable_blogforum_replies = isset( $bp->site_options['bp-disable-blogforum-comments'] ) ? $bp->site_options['bp-disable-blogforum-comments'] : false;
+        $this->disable_blogforum_replies = (bool) bp_core_get_root_option( 'bp-disabled-blogforum-comments' );
 
         // Get an array of the logged in user's favorite activities

trunk/src/bp-blogs/bp-blogs-filters.php

@@ -87 +87 @@
      * That plugin changed the way its settings were stored at some point. Thus the dual check.
      */
-    if ( ! empty( $bp->site_options['sitewide_tags_blog'] ) ) {
-        $st_options = maybe_unserialize( $bp->site_options['sitewide_tags_blog'] );
+    $sitewide_tags_blog_settings = bp_core_get_root_option( 'sitewide_tags_blog' );
+    if ( ! empty( $sitewide_tags_blog_settings ) ) {
+        $st_options = maybe_unserialize( $sitewide_tags_blog_settings );
         $tags_blog_id = isset( $st_options['tags_blog_id'] ) ? $st_options['tags_blog_id'] : 0;
     } else {
-        $tags_blog_id = isset( $bp->site_options['tags_blog_id'] ) ? $bp->site_options['tags_blog_id'] : 0;
+        $tags_blog_id = bp_core_get_root_option( 'sitewide_tags_blog' );
+        $tags_blog_id = intval( $tags_blog_id );
     }
 

trunk/src/bp-core/bp-core-avatars.php

@@ -32 +32 @@
     if ( !defined( 'BP_AVATAR_ORIGINAL_MAX_FILESIZE' ) ) {
 
-        if ( !isset( $bp->site_options['fileupload_maxk'] ) ) {
+        $fileupload_maxk = bp_core_get_root_option( 'fileupload_maxk' );
+        if ( '' === $fileupload_maxk ) {
             define( 'BP_AVATAR_ORIGINAL_MAX_FILESIZE', 5120000 ); // 5mb
         } else {
-            define( 'BP_AVATAR_ORIGINAL_MAX_FILESIZE', $bp->site_options['fileupload_maxk'] * 1024 );
+            define( 'BP_AVATAR_ORIGINAL_MAX_FILESIZE', $fileupload_maxk * 1024 );
         }
     }

trunk/src/bp-core/bp-core-options.php

@@ -482 +482 @@
 }
 
+/**
+ * Get a root option.
+ *
+ * "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 {@see bp_core_get_root_options()}.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param  string $option Name of the option key.
+ * @return mixed Value, if found.
+ */
+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;
+}
+
 /** Active? *******************************************************************/
 

trunk/src/bp-core/bp-core-template.php

@@ -820 +820 @@
         }
 
-        $status = buddypress()->site_options['registration'];
+        $status = bp_core_get_root_option( 'registration' );
         if ( ( 'none' !== $status ) && ( 'user' !== $status ) ) {
             return true;

trunk/src/bp-forums/bp-forums-loader.php

@@ -58 +58 @@
 
         // The location of the bbPress stand-alone config file
-        if ( isset( $bp->site_options['bb-config-location'] ) )
-            $this->bbconfig = $bp->site_options['bb-config-location'];
+        $bbconfig = bp_core_get_root_option( 'bb-config-location' );
+        if ( '' !== $bbconfig )
+            $this->bbconfig = $bbconfig;
 
         // All globals for messaging component.

trunk/src/bp-groups/bp-groups-loader.php

@@ -299 +299 @@
 
         // If avatar uploads are not disabled, add avatar option
-        if ( ! (int) $bp->site_options['bp-disable-avatar-uploads'] && $bp->avatar->show_avatars ) {
+        $disabled_avatar_uploads = (int) bp_core_get_root_option( 'bp-disable-avatar-uploads' );
+        if ( ! $disabled_avatar_uploads && $bp->avatar->show_avatars ) {
             $this->group_creation_steps['group-avatar'] = array(
                 'name'     => _x( 'Photo', 'Group screen nav', 'buddypress' ),

trunk/src/bp-members/bp-members-screens.php

@@ -157 +157 @@
         // Finally, let's check the blog details, if the user wants a blog and blog creation is enabled
         if ( isset( $_POST['signup_with_blog'] ) ) {
-            $active_signup = $bp->site_options['registration'];
+            $active_signup = bp_core_get_root_option( 'registration' );
 
             if ( 'blog' == $active_signup || 'all' == $active_signup ) {
@@ -197 +197 @@
 
             // No errors! Let's register those deets.
-            $active_signup = !empty( $bp->site_options['registration'] ) ? $bp->site_options['registration'] : '';
+            $active_signup = bp_core_get_root_option( 'registration' );
 
             if ( 'none' != $active_signup ) {

trunk/src/bp-members/bp-members-template.php

@@ -2245 +2245 @@
 
         if ( is_multisite() ) {
-            if ( ! isset( $bp->site_options ) ) {
-                $bp->site_options = bp_core_get_root_options();
-            }
-
-            if ( in_array( $bp->site_options['registration'], array( 'all', 'user' ) ) ) {
+            $registration = bp_core_get_root_option( 'registration' );
+
+            if ( in_array( $registration, array( 'all', 'user' ) ) ) {
                 $signup_allowed = true;
             }

trunk/src/bp-settings/bp-settings-loader.php

@@ -184 +184 @@
 
             // Delete Account
-            if ( !bp_current_user_can( 'bp_moderate' ) && empty( $bp->site_options['bp-disable-account-deletion'] ) ) {
+            if ( !bp_current_user_can( 'bp_moderate' ) && ! bp_core_get_root_option( 'bp-disable-account-deletion' ) ) {
                 $wp_admin_nav[] = array(
                     'parent' => 'my-account-' . $this->id,

trunk/src/bp-xprofile/bp-xprofile-loader.php

@@ -96 +96 @@
         // Defined conditionally to accommodate unit tests
         if ( ! defined( 'BP_XPROFILE_BASE_GROUP_NAME' ) ) {
-            define( 'BP_XPROFILE_BASE_GROUP_NAME', stripslashes( $bp->site_options['bp-xprofile-base-group-name'] ) );
+            define( 'BP_XPROFILE_BASE_GROUP_NAME', stripslashes( bp_core_get_root_option( 'avatar_default' ) ) );
         }
 
         if ( ! defined( 'BP_XPROFILE_FULLNAME_FIELD_NAME' ) ) {
-            define( 'BP_XPROFILE_FULLNAME_FIELD_NAME', stripslashes( $bp->site_options['bp-xprofile-fullname-field-name'] ) );
+            define( 'BP_XPROFILE_FULLNAME_FIELD_NAME', stripslashes( bp_core_get_root_option( 'bp-xprofile-fullname-field-name' ) ) );
         }
 

trunk/tests/phpunit/testcases/core/functions.php

@@ -522 +522 @@
 
     /**
+     * @group bp_core_get_root_option
+     */
+    public function test_bp_core_get_root_option_with_unpopulated_cache() {
+        // Back up and unset global cache.
+        $old_options = buddypress()->site_options;
+        unset( buddypress()->site_options );
+
+        $this->assertSame( $old_options['avatar_default'], bp_core_get_root_option( 'avatar_default' ) );
+
+        // Clean up.
+        buddypress()->site_options = $old_options;
+    }
+
+    /**
+     * @group bp_core_get_root_option
+     */
+    public function test_bp_core_get_root_option_with_populated_cache() {
+        // Back up and unset global cache.
+        $old_options = buddypress()->site_options;
+        buddypress()->site_options = bp_core_get_root_options();
+        $expected = buddypress()->site_options['avatar_default'];
+
+        $this->assertSame( $expected, bp_core_get_root_option( 'avatar_default' ) );
+    }
+
+    /**
      * @group bp_core_add_root_component
      */