bp_get_user_meta_key

Filters the meta_key for a given piece of user metadata.

Description

apply_filters( 'bp_get_user_meta_key', (string) $key ); 

Parameters (1)

0. $key (string)
The usermeta meta key.

Usage

To run the hook, copy the example below.
  1. $key = apply_filters( 'bp_get_user_meta_key', $key ); 
  2.  
  3. if ( !empty( $key ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the bp_get_user_meta_key callback 
  2. function filter_bp_get_user_meta_key( $key ) { 
  3. // make filter magic happen here... 
  4. return $key
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_get_user_meta_key', 'filter_bp_get_user_meta_key', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_get_user_meta_key', 'filter_bp_get_user_meta_key', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/bp-core/bp-core-functions.php  
  1. return apply_filters( 'bp_get_user_meta_key', $key );