bp_login_redirect

Filters the URL to redirect to after login.

Description

apply_filters( 'bp_login_redirect', (string) $redirect_to, (string) $redirect_to_raw, (WP_User|WP_Error) $user ); 

Parameters (3)

0. $redirect_to (string)
The redirect destination URL.
1. $redirect_to_raw (string)
The requested redirect destination URL passed as a parameter.
2. $user (WP_User|WP_Error)
WP_User object if login was successful, WP_Error object otherwise.

Usage

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

Defined (1)

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

/bp-core/bp-core-dependency.php  
  1. return apply_filters( 'bp_login_redirect', $redirect_to, $redirect_to_raw, $user );