bp_core_render_email_template( string $template )

Find and render the template for Email posts (the Customizer and admin previews).

Description

Misuses the template_include filter which expects a string, but as we need to replace the {{{content}}} token with the post’s content, we use object buffering to load the template, replace the token, and render it.

The function returns an empty string to prevent WordPress rendering another template.

Parameters

$template: (Required) Path to template (probably single.php).

Return

(string)

Source

File: bp-core/bp-core-filters.php

function bp_core_render_email_template( $template ) {
    if ( get_post_type() !== bp_get_email_post_type() || ! is_single() ) {
        return $template;
    }
 
    /**
     * Filter template used to display Email posts.
     *
     * @since BuddyPress 2.5.0
     *
     * @param string $template Path to current template (probably single.php).
     */
    $email_template = apply_filters( 'bp_core_render_email_template',
        bp_locate_template( bp_email_get_template( get_queried_object() ), false ),
        $template
    );
 
    if ( ! $email_template ) {
        return $template;
    }
 
    ob_start();
    include( $email_template );
    $template = ob_get_contents();
    ob_end_clean();
 
    // Make sure we add a <title> tag so WP Customizer picks it up.
    $template = str_replace( '<head>', '<head><title>' . esc_html__( 'BuddyBoss Emails', 'buddyboss' ) . '</title>', $template );
    echo str_replace( '{{{content}}}', wpautop( get_post()->post_content ), $template );
 
    /*
     * Link colours are applied directly in the email template before sending, so we
     * need to add an extra style here to set the colour for the Customizer or preview.
     */
    $settings = bp_email_get_appearance_settings();
    printf(
        '<style>a { color: %s; }</style>',
        esc_attr( $settings['highlight_color'] )
    );
 
    return '';
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.5.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-functions.php: bp_email_get_template()	Get the paths to possible templates for the specified email object.
bp-core/bp-core-functions.php: bp_email_get_appearance_settings()	Return email appearance settings.
bp-core/bp-core-functions.php: bp_get_email_post_type()	Returns the name of the email post type.
bp-core/bp-core-filters.php: bp_core_render_email_template	Filter template used to display Email posts.
bp-core/bp-core-template-loader.php: bp_locate_template()	Retrieve the name of the highest priority template file that exists.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents