bb_user_nicename_sanitize

The BuddyPress bb user nicename sanitize hook.

Description

apply_filters( 'bb_user_nicename_sanitize', (string) $bb_sanitize_with_dashes, (string) $user_nicename, (unknown) $length ); 

Parameters (3)

0. $bb_sanitize_with_dashes (string) => bb_sanitize_with_dashes( $user_nicename, $length )
The bb sanitize with dashes.
1. $user_nicename (string)
The user nicename.
2. $length (unknown)
The length.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-formatting.php  
  1. return apply_filters( 'bb_user_nicename_sanitize', bb_sanitize_with_dashes( $user_nicename, $length ), $_user_nicename, $length );