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

Timestamp:

05/16/2011 10:22:39 PM (14 years ago)

Author:

boonebgorges

Message:

Refactors user_meta key filtering to remove overhead in the bp global. Fixes #2952. Props nacin.

File:

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

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

@@ -28 +28 @@
 
     $page_blog_id = $is_enable_multiblog ? get_current_blog_id() : BP_ROOT_BLOG;
-    
+
     // Upgrading from an earlier version of BP pre-1.3
     if ( empty( $page_ids ) || isset( $page_ids['members'] ) ) {        
@@ -1001 +1001 @@
  * BuddyPress stores a number of pieces of userdata in the WordPress central usermeta table. In
  * order to allow plugins to enable multiple instances of BuddyPress on a single WP installation,
- * BP's usermeta keys are abstracted and stored in the $bp global, at $bp->user_meta_keys.
+ * BP's usermeta keys are filtered with this function, so that they can be altered on the fly.
  *
  * Plugin authors who access or modify metadata created by BuddyPress should use
@@ -1009 +1009 @@
  * 
  * If your plugin introduces custom user metadata that might change between multiple BP instances
- * on a single WP installation, you are strongly recommended to register your meta keys in the $bp
- * global (see BP_Core_Component::setup_globals()), and use this function when storing and
+ * on a single WP installation, you are strongly recommended to use this function when storing and
  * retrieving metadata.
  *
  * @package BuddyPress
  * @since 1.3
- * @see BP_Core_Component::_setup_globals()
  *
  * @uses apply_filters() Filter bp_get_user_meta_key to modify keys individually
- * @param str $name
+ * @param str $key
  * @return str $key
  */
-function bp_get_user_meta_key( $name = false ) {
-    global $bp;
-    
-    if ( !$name )
-        return false;
-    
-    $key = isset( $bp->user_meta_keys->$name ) ? $bp->user_meta_keys->$name : false;
-    
-    return apply_filters( 'bp_get_user_meta_key', $key, $name );
+function bp_get_user_meta_key( $key = false ) {
+    return apply_filters( 'bp_get_user_meta_key', $key );
 }