bp_email_get_unsubscribe_type_schema

Filters the return of `bp_email_get_type_schema( 'all' )` for use with our unsubscribe functionality.

Description

apply_filters( 'bp_email_get_unsubscribe_type_schema', (array) $emails ); 

Parameters (1)

0. $emails (array)
The array of email types and their schema.

Usage

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

Defined (1)

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

/bp-core/bp-core-functions.php  
  1. return (array) apply_filters( 'bp_email_get_unsubscribe_type_schema', $emails );