bbp_favorites_handler

The bbPress bbp favorites handler hook.

Description

do_action( 'bbp_favorites_handler', (unknown) $success, (unknown) $user_id, (unknown) $topic_id, (unknown) $action ); 

Parameters (4)

0. $success (unknown)
The success.
1. $user_id (unknown)
The user id.
2. $topic_id (unknown)
The topic id.
3. $action (unknown)
The action.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'bbp_favorites_handler', $success, $user_id, $topic_id, $action ); 
The following example is for adding a hook callback.
  1. // define the bbp_favorites_handler callback 
  2. function action_bbp_favorites_handler( $success, $user_id, $topic_id, $action ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'bbp_favorites_handler', 'action_bbp_favorites_handler', 10, 4 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'bbp_favorites_handler', 'action_bbp_favorites_handler', 10, 4 ); 

Defined (1)

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

/includes/users/functions.php  
  1. do_action( 'bbp_favorites_handler', $success, $user_id, $topic_id, $action );