bp_get_displayed_user

Filters the displayed_user object corresponding to the displayed member.

Description

apply_filters( 'bp_get_displayed_user', (object) $displayed_user ); 

Parameters (1)

0. $displayed_user (object)
The displayed_user object.

Usage

To run the hook, copy the example below.
  1. $displayed_user = apply_filters( 'bp_get_displayed_user', $displayed_user ); 
  2.  
  3. if ( !empty( $displayed_user ) ) { 
  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_displayed_user callback 
  2. function filter_bp_get_displayed_user( $displayed_user ) { 
  3. // make filter magic happen here... 
  4. return $displayed_user
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_get_displayed_user', 'filter_bp_get_displayed_user', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_get_displayed_user', 'filter_bp_get_displayed_user', 10, 1 ); 

Defined (1)

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

/bp-members/bp-members-functions.php  
  1. return apply_filters( 'bp_get_displayed_user', $displayed_user );