# mainwp/6.2.1/class/class-mainwp-notification-template.php

MainWP Dashboard: Self-hosted WordPress Management for Agencies, version 6.2.1. 429 lines.

- Page: https://pluginprobe.com/plugins/mainwp/6.2.1/code/class/class-mainwp-notification-template.php
- Raw: https://pluginprobe.com/plugins/mainwp/6.2.1/raw/class/class-mainwp-notification-template.php
- Modified: 2026-09-09T15:30:44+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/mainwp/6.2.1/code/class/class-mainwp-notification-template.php#L10-L20`.

```php
<?php
/**
 * MainWP notification template
 *
 * @package     MainWP/Dashboard
 */

namespace MainWP\Dashboard;

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
    exit;
}

/**
 * Class MainWP_Notification_Template
 *
 * @package MainWP\Dashboard
 */
class MainWP_Notification_Template { // phpcs:ignore Generic.Classes.OpeningBraceSameLine.ContentAfterBrace -- NOSONAR.

    /**
     * Private static variable to hold the single instance of the class.
     *
     * @static
     *
     * @var mixed Default null.
     */
    private static $instance = null;


    /**
     * Template directory.
     *
     * @var string Default empty.
     */
    private $template_path = '';

    /**
     * Custom template directory.
     *
     * @var string Default empty.
     */
    private $template_custom_path = '';

    /**
     * Method get_class_name()
     *
     * Get Class Name.
     *
     * @return string Class name.
     */
    public static function get_class_name() {
        return __CLASS__;
    }

    /**
     * Create a new Self Instance.
     *
     * @return mixed static::$instance
     */
    public static function instance() {
        if ( null === static::$instance ) {
            static::$instance = new self();
        }
        return static::$instance;
    }

    /**
     * MainWP_Notification_Template constructor.
     *
     * Run each time the class is called.
     *
     * @uses \MainWP\Dashboard\MainWP_System_Utility::get_mainwp_sub_dir()
     */
    public function __construct() {
        $this->template_path        = MAINWP_PLUGIN_DIR . 'templates/';
        $this->template_custom_path = MainWP_System_Utility::get_mainwp_sub_dir( 'templates' );
        // create custom template folders if does not existed.
        MainWP_System_Utility::get_mainwp_sub_dir( 'templates/emails' );
    }

    /**
     * Get default templates folder.
     *
     * @return string folder.
     */
    public function get_default_templates_dir() {
        return $this->template_path;
    }

    /**
     * Get custom templates folder.
     *
     * @return string folder.
     */
    public function get_custom_templates_dir() {
        return $this->template_custom_path;
    }

    /**
     * Get template HTML.
     *
     * Credits.
     *
     * Plugin-Name: WooCommerce.
     * Plugin URI: https://woocommerce.com/.
     * Author: Automattic.
     * Author URI: https://woocommerce.com.
     * License: GPLv3 or later.
     *
     * @param string $template_name Template name.
     * @param array  $args          Arguments. (default: array).
     *
     * @return string
     */
    public function get_template_html( $template_name, $args = array() ) {
        return $this->get_template( $template_name, $args );
    }

    /**
     * Get templates.
     *
     * Credits.
     *
     * Plugin-Name: WooCommerce.
     * Plugin URI: https://woocommerce.com/.
     * Author: Automattic.
     * Author URI: https://woocommerce.com.
     * License: GPLv3 or later.
     *
     * @param string $template_name Template name.
     * @param array  $args          Arguments. (default: array).
     *
     * @return false|string|void
     *
     * @uses \MainWP\Dashboard\MainWP_Notification_Settings::replace_tokens_for_content()
     * @uses  \MainWP\Dashboard\MainWP_Utility::get_timestamp()
     */
    public function get_template( $template_name, $args = array() ) {

        // template full path.
        $template = $this->locate_template( $template_name );

        /**
         * Filter: mainwp_get_template
         *
         * Filters available templates and adds support for 3rd party templates.
         *
         * @param string $template_name Template name.
         * @param array  $args          Args.
         *
         * @since 4.1
         */
        $filter_template = apply_filters( 'mainwp_get_template', $template, $template_name, $args );

        if ( $filter_template !== $template ) {
            $template = $filter_template;
        }

        $located = $template;

        if ( ! file_exists( $located ) ) {
            return '';
        }

        extract( $args ); // @codingStandardsIgnoreLine

        ob_start();

        /**
         * Action: mainwp_before_template_part
         *
         * Fires before the email template is loaded.
         *
         * @param string   $template_name Template name.
         * @param resource $located Template file.
         * @param array    $args    Args.
         *
         * @since 4.1
         */
        do_action( 'mainwp_before_template_part', $template_name, $located, $args );

        include $located; // NOSONAR - WP compatible. // `include` to fix loop load the template content.

        /**
         * Action: mainwp_after_template_part
         *
         * Fires after the email template is loaded.
         *
         * @param string   $template_name Template name.
         * @param resource $located Template file.
         * @param array    $args    Args.
         *
         * @since 4.1
         */
        do_action( 'mainwp_after_template_part', $template_name, $located, $args );

        $content = ob_get_clean();

        if ( isset( $current_email_site ) && is_object( $current_email_site ) ) {

            $content = MainWP_Notification_Settings::replace_tokens_for_content( $content, $current_email_site );

            if ( isset( $child_site_tokens ) && ! empty( $child_site_tokens ) ) {

                if ( ! isset( $timestamp_from_date ) || empty( $timestamp_from_date ) || ! isset( $timestamp_to_date ) || empty( $timestamp_to_date ) ) {
                    $now_timestamp       = MainWP_Utility::get_timestamp();
                    $timestamp_from_date = $now_timestamp - DAY_IN_SECONDS;
                    $timestamp_to_date   = $now_timestamp;
                }

                if ( preg_match( '/\[[^\]]+\]/is', $content, $matches ) ) {

                    /**
                     * Filter: mainwp_pro_reports_generate_content
                     *
                     * Filters the Pro Reports available content.
                     *
                     * @since 4.1
                     */
                    $content = apply_filters( 'mainwp_pro_reports_generate_content', $content, $current_email_site->id, $timestamp_from_date, $timestamp_to_date );

                    /**
                     * Filter: mainwp_client_report_generate_content
                     *
                     * Filters the Client Reports available content.
                     *
                     * @since 4.1
                     */
                    $content = apply_filters( 'mainwp_client_report_generate_content', $content, $current_email_site->id, $timestamp_from_date, $timestamp_to_date );
                }
            }
        }

        return $content;
    }

    /**
     * Locate a template and return the path for inclusion.
     *
     * Credits.
     *
     * Plugin-Name: WooCommerce.
     * Plugin URI: https://woocommerce.com/.
     * Author: Automattic.
     * Author URI: https://woocommerce.com.
     * License: GPLv3 or later.
     *
     * @param string $template_name Template name.
     * @return string
     */
    private function locate_template( $template_name ) {

        $template = '';

        // Look within custom path - this is priority.
        $template_path = $this->template_custom_path;
        if ( file_exists( $template_path . $template_name ) ) {
            $template = $template_path . $template_name;
        }

        // Get default template.
        if ( ! $template ) {
            $template_path = $this->template_path;
            $template_path = apply_filters( 'mainwp_default_template_source_dir', $template_path, $template_name );
            $template      = $template_path . $template_name;
        }

        /**
         * Filer: mainwp_locate_template
         *
         * Filters the template location.
         *
         * @param string $template_name Template name.
         * @param string $template_path Template path.
         *
         * @since 4.1
         */
        return apply_filters( 'mainwp_locate_template', $template, $template_name, $template_path );
    }

    /**
     * Check if it is overrided template.
     *
     * @param string $type Email type.
     *
     * @return bool True|False
     */
    public function is_overrided_template( $type ) {
        $templ = static::get_template_name_by_notification_type( $type );
        if ( file_exists( $this->template_custom_path . $templ ) ) {
            return true;
        }
        return false;
    }

    /**
     * Get default template name by email/notification type.
     *
     * @param string $type email/notification type.
     *
     * @return string|null Template name.
     */
    public static function get_template_name_by_notification_type( $type = '' ) {
        $types = array(
            'daily_digest'              => 'emails/mainwp-daily-digest-email.php',
            'auto_updates'              => 'emails/mainwp-auto-updates-notification-email.php',
            'uptime'                    => 'emails/mainwp-uptime-monitoring-email.php',
            'site_health'               => 'emails/mainwp-site-health-monitoring-email.php',
            'http_check'                => 'emails/mainwp-after-update-http-check-email.php',
            'deactivated_license_alert' => 'emails/mainwp-licenses-deactivated-alert-email.php',
        );

        $addition_template_name = apply_filters( 'mainwp_get_notification_template_name_by_type', '', $type );
        if ( ! empty( $addition_template_name ) ) {
            return $addition_template_name;
        }

        return isset( $types[ $type ] ) ? $types[ $type ] : null;
    }


    /**
     * Method handle_template_file_action()
     *
     * Handle template file action.
     *
     * @return bool $done handle result.
     *
     * @uses \MainWP\Dashboard\MainWP_System_Utility::get_wp_file_system()
     */
    public function handle_template_file_action() { // phpcs:ignore -- NOSONAR - complex.
        $updated_templ = false;

        $hasWPFileSystem = MainWP_System_Utility::get_wp_file_system();

        /**
         * WordPress files system object.
         *
         * @global object
         */
        global $wp_filesystem;

        $type            = isset( $_GET['edit-email'] ) ? sanitize_text_field( wp_unslash( $_GET['edit-email'] ) ) : '';
        $templ_base_name = ! empty( $type ) ? static::get_template_name_by_notification_type( $type ) : '';

        if ( ! empty( $templ_base_name ) && isset( $_GET['_wpnonce'] ) && wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'delete-email-template' ) && $hasWPFileSystem ) {
            $dir     = $this->template_custom_path;
            $deleted = $wp_filesystem->delete( $dir . $templ_base_name );
            if ( $deleted ) {
                $updated_templ = 1;
            }
        }

        if ( ! empty( $templ_base_name ) && isset( $_GET['_wpnonce'] ) && wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'copy-email-template' ) && $hasWPFileSystem ) {
            $template_path = $this->template_path;
            $source_dir    = apply_filters( 'mainwp_default_template_source_dir', $template_path, $templ_base_name );
            $dest_dir      = $this->template_custom_path;
            $copied        = $wp_filesystem->copy( $source_dir . $templ_base_name, $dest_dir . $templ_base_name );
            if ( $copied ) {
                $updated_templ = 2;
            }
        }

        if ( ! empty( $templ_base_name ) && isset( $_POST['wp_nonce'] ) && wp_verify_nonce( sanitize_key( $_POST['wp_nonce'] ), 'save-email-template' ) ) {
            $template_code = isset( $_POST[ 'edit_' . $type . '_code' ] ) ? wp_unslash( $_POST[ 'edit_' . $type . '_code' ] ) : ''; //phpcs:ignore -- saving template content.
            $updated       = $this->save_template( $template_code, $templ_base_name );
            if ( true === $updated ) {
                $updated_templ = 3;
            } else {
                $updated_templ = $updated;
            }
        }

        return $updated_templ;
    }

    /**
     * Save the email templates.
     *
     * Credits.
     *
     * Plugin-Name: WooCommerce.
     * Plugin URI: https://woocommerce.com/.
     * Author: Automattic.
     * Author URI: https://woocommerce.com.
     * License: GPLv3 or later.
     *
     * @since 4.1
     * @param string $template_code Template code.
     * @param string $template Template.
     */
    public function save_template( $template_code, $template ) {
        $failed = 31;
        if ( empty( $template ) || empty( $template_code ) ) {
            $failed = 34;
        } elseif ( ! current_user_can( 'edit_themes' ) ) {
            $failed = 35;
        } else {
            $saved = false;
            $file  = $this->template_custom_path . $template;
            $code  = str_replace( PHP_EOL, '', $template_code ); // to fix issue create extra line breaks in custom template file.

            $is_writable = MainWP_System_Utility::is_writable( $file );
            // phpcs:disable WordPress.WP.AlternativeFunctions
            if ( $is_writable ) {
                $f = fopen( $file, 'w+' );
                if ( false !== $f ) {
                    fwrite( $f, $code );
                    fclose( $f );
                    $saved = true;
                } else {
                    $failed = 32;
                }
            } else {
                $failed = 33;
            }
            //phpcs:enable

            if ( $saved ) {
                return true;
            }
        }
        MainWP_Logger::instance()->debug( 'Saving email template failed :: [file=' . $this->template_custom_path . $template . ']' );
        return $failed;
    }
}

```
