bbp_subscription_mail_message

The bbPress bbp subscription mail message hook.

Description

apply_filters( 'bbp_subscription_mail_message', (unknown) $message, (unknown) $reply_id, (unknown) $topic_id ); 

Parameters (3)

0. $message (unknown)
The message.
1. $reply_id (unknown)
The reply id.
2. $topic_id (unknown)
The topic id.

Usage

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

Defined (1)

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

/includes/common/functions.php  
  1. $message = apply_filters( 'bbp_subscription_mail_message', $message, $reply_id, $topic_id );