Ticket #6045: 6045.patch

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

@@ -217 +217 @@
                 $this->pag_num  = isset( $_REQUEST['num'] ) ? intval( $_REQUEST['num'] ) : $per_page;
 
                 // 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
                 $this->my_favs = maybe_unserialize( bp_get_user_meta( bp_loggedin_user_id(), 'bp_favorite_activities', true ) );

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

@@ -86 +86 @@
          * Stop infinite loops with WordPress MU Sitewide Tags.
          * 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 );
         }
 
         /**

src/bp-blogs/bp-blogs-template.php

@@ -1114 +1114 @@
 function bp_blog_signup_enabled() {
         global $bp;
 
-        $active_signup = isset( $bp->site_options['registration'] ) ? $bp->site_options['registration'] : 'all';
+        $active_signup = bp_core_get_root_option( 'registration' );
+        if ( ! $active_signup ) {
+                $active_signup = 'all';
+        }
 
         /**
          * Filters whether or not blog creation is enabled.

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

@@ -31 +31 @@
 
         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 );
                 }
         }
 

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

@@ -432 +432 @@
         return apply_filters( 'bp_core_get_root_options', $root_blog_options_meta );
 }
 
+/**
+ * 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.2.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? *******************************************************************/
 
 /**

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

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

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

@@ -57 +57 @@
                         define( 'BP_FORUMS_SLUG', $this->id );
 
                 // 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.
                 // Note that global_tables is included in this array.

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

@@ -270 +270 @@
                 ) );
 
                 // 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' ),
                                 'position' => 20

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

@@ -118 +118 @@
 
                 // 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 ) {
                                 $blog_details = bp_core_validate_blog_signup( $_POST['signup_blog_url'], $_POST['signup_blog_title'] );
@@ -145 +145 @@
                         $bp->signup->step = 'save-details';
 
                         // 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 ) {
 

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

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

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

@@ -183 +183 @@
                         }
 
                         // 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,
                                         'id'     => 'my-account-' . $this->id . '-delete-account',

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

@@ -91 +91 @@
                 // to use in SQL statements.
                 // 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' ) ) );
                 }
 
                 // Set the support field type ids

tests/phpunit/testcases/core/functions.php

@@ -563 +563 @@
         }
 
         /**
+         * @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
          */
         public function test_add_root_component_not_in_bp_pages() {