bbp_get_user_id

The bbPress bbp get user id hook.

Description

apply_filters( 'bbp_get_user_id', (int) $int_bbp_user_id, (unknown) $displayed_user_fallback, (unknown) $current_user_fallback ); 

Parameters (3)

0. $int_bbp_user_id (int) => (int) $bbp_user_id
The int bbp user id.
1. $displayed_user_fallback (unknown)
The displayed user fallback.
2. $current_user_fallback (unknown)
The current user fallback.

Usage

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

Defined (1)

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

/includes/users/template.php  
  1. return (int) apply_filters( 'bbp_get_user_id', (int) $bbp_user_id, $displayed_user_fallback, $current_user_fallback );