bp_email_set_default_headers( array $headers, string $property, string $transform, BP_Email $email )
Add custom headers to outgoing emails.
Description Description
Parameters Parameters
- $headers
-
(Required) Array of email headers.
- $property
-
(Required) Name of property. Unused.
- $transform
-
(Required) Return value transformation. Unused.
-
(Required) Email object reference.
Return Return
(array)
Source Source
File: bp-core/bp-core-filters.php
function bp_email_set_default_headers( $headers, $property, $transform, $email ) {
$headers['X-BuddyPress'] = bp_get_version();
$headers['X-BuddyPress-Type'] = $email->get( 'type' );
$tokens = $email->get_tokens();
// Add 'List-Unsubscribe' header if applicable.
if ( ! empty( $tokens['unsubscribe'] ) && $tokens['unsubscribe'] !== wp_login_url() ) {
$user = get_user_by( 'email', $tokens['recipient.email'] );
$link = bp_email_get_unsubscribe_link( array(
'user_id' => $user->ID,
'notification_type' => $email->get( 'type' ),
) );
if ( ! empty( $link ) ) {
$headers['List-Unsubscribe'] = sprintf( '<%s>', esc_url_raw( $link ) );
}
}
return $headers;
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |