bp_get_email_args

Filters arguments used to find an email post type object.

Description

apply_filters( 'bp_get_email_args', (array) $args, (string) $email_type ); 

Parameters (2)

0. $args (array)
Arguments for get_posts() used to fetch a post object.
1. $email_type (string)
Unique identifier for a particular type of email.

Usage

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

Defined (1)

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

/bp-core/bp-core-functions.php  
  1. $args = apply_filters( 'bp_get_email_args', $args, $email_type );