Add Email Notification Unsubscribe Link to all BuddyPress Emails
BuddyPress allows users to unsubscribe from email notifications without logging in to the site. The unsubscribe link is part of the email header(allows your email clients to attempt unsubscribe) and in the footer of the html email as shown below.
The Unsubscribe link is not visible to the users when using BuddyPress email in plaintext mode.
There are times when you may want to enable the unsubscibe link under content. For example
- If you are not using BuddyPress html email, you can add the unsubscribe link at the bottom of the email.
- Or you are using BuddyPress html email but want the link to be more prominent part of the content.
How do we filter the BuddyPress email content:-
There are two types of BuddyPress email content possible
- html
- and plaintext
BuddyPress provides us with a filter for each of the content type to filter the email content globally.
- bp_email_get_content_html :- To filter the content for html email.
- bp_email_get_content_plaintext :- To filter the content for plain text email.
If you are searching for the filter in your IDE, It is in "BP_Email" class and you should search for the dynamic filter bp_email_get_{$property_name}.
Since both the filter offers same data, we can write a simple function to filter the content and based on the content type(html/plaintext) add appropriate tag. The filter provides four arguments but we are only interested in the content and content type here, so I will only use these two.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | /** * Filter BuddyPress Email Content globally. * * @param string $content email content. * @param string $content_type content type(html, plaintext). * * @return string */ function buddydev_bp_email_filter_add_subscribe_link( $content, $content_type ) { if ( 'content_html' === $content_type ) { $content .= '<p class="bp-email-subscribe-link"><a href="{{{unsubscribe}}}">Unsubscribe</a>'; } else { // plaintext. $content .= "\r\n Unsubscribe: {{unsubscribe}}"; } return $content; } |
As shown in the code, if the content type is html, we add a paragraph and an anchor element but if the content type is plaintext, we simply add text url.
Now, we need to add the filters.
To enable for plain text, we will use
1 | add_filter( 'bp_email_get_content_plaintext', 'buddydev_bp_email_filter_add_subscribe_link', 10, 2 ); |
And if you really want to append to html email content too, you can add this filter too
1 | add_filter( 'bp_email_get_content_html', 'buddydev_bp_email_filter_add_subscribe_link', 10, 2 ); |
Adding Unsubscribe link to specific BuddyPress emails
If you want, you can insert the email notification unsubscribe link in specific BuddyPress emails too. You can use the tokens and edit the emails in dashboard to do that. The relevant token is {{unsubscribe}}.
Here is what you should insert in the html email
1 | <a href="{{{unsubscribe}}}">Unsubscribe</a> |
And in the plan text email, we don't need html tag, we can simply use the unsubscribe token as
1 | {{unsubscribe}} |
That's all.
Hope you are enjoying BuddyPress. We are certainly loving it.