Changeset 9698 for trunk/src/bp-core/bp-core-options.php

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.

File:

• trunk/src/bp-core/bp-core-options.php (modified) (1 diff)

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? *******************************************************************/