# yaymail/4.4.5/src/Abstracts/BaseEmail.php

YayMail – WooCommerce Email Customizer, version 4.4.5. 180 lines.

- Page: https://pluginprobe.com/plugins/yaymail/4.4.5/code/src/Abstracts/BaseEmail.php
- Raw: https://pluginprobe.com/plugins/yaymail/4.4.5/raw/src/Abstracts/BaseEmail.php
- Modified: 2026-09-24T13:41:54+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/yaymail/4.4.5/code/src/Abstracts/BaseEmail.php#L10-L20`.

```php
<?php
namespace YayMail\Abstracts;

use YayMail\Models\TemplateModel;
use YayMail\YayMailTemplate;

/**
 * Base Email Class
 */
abstract class BaseEmail {

    /**
     * Contains id of the email
     * Id also means template name in some case
     *
     * @var string
     */
    protected $id;

    /**
     * Email name
     *
     * @var string
     */
    protected $title;

    /**
     * Contains recipient
     *
     * @var string
     */
    protected $recipient;

    /**
     * Which plugin email created by
     */
    protected $source = [
        'plugin_id'   => 'woocommerce',
        'plugin_name' => 'WooCommerce',
    ];

    protected $shortcodes = [];

    protected $root_email = null;

    protected $is_existed = true;

    /**
     * Example values: non_order, order, global_header_footer, ...
     */
    public $email_types = [ YAYMAIL_WITH_ORDER_EMAILS ];

    /**
     * Indicate which template that process is working on
     */
    public $template = null;

    /**
     * Render priority
     *
     * @var int
     */
    protected $render_priority = YAYMAIL_EMAIL_RENDER_PRIORITY;

    /**
     * Callback for yaymail_emails hook
     * Return this email data
     */
    public function get_email_data() {
        return [
            'id'        => $this->id,
            'title'     => $this->title,
            'recipient' => $this->recipient,
            'source'    => $this->source,
        ];
    }

    abstract public function get_template_path();

    abstract public function get_default_elements();

    /**
     * Function check current template is WooCommerce email
     * Return boolean
     */
    protected function is_template_email( $email ) {
        return ! empty( $email->id ) && $email->id === $this->id;
    }

    public function get_language( $order ) {
        return '';
    }

    public function get_id() {
        return $this->id;
    }

    public function get_template_file( $located, $template_name, $args ) {
        if ( ! isset( $args['email'] ) ) {
            return $located;
        }
        if ( ! $args['email'] instanceof \WC_Email || ! $this->is_template_email( $args['email'] ) ) {
            return $located;
        }
        $template_path = $this->get_template_path();
        if ( ! file_exists( $template_path ) ) {
            return $located;
        }

        return $this->load_template( $args ) ? $template_path : $located;
    }

    /**
     * Resolve the variant and load the YayMail template into $this->template.
     * The default design decides whether YayMail renders this email at all;
     * a variant only swaps the design when an addon returns one via `yaymail_email_get_variant`.
     *
     * @param array       $args          wc_get_template args.
     * @param string|null $template_name Template to load; defaults to this email's id.
     * @return bool True when a YayMail template should render.
     */
    protected function load_template( $args, $template_name = null ) {
        $template_name = $template_name ?? $this->id;
        $order         = isset( $args['order'] ) ? $args['order'] : null;

        $this->template = new YayMailTemplate( $template_name );
        if ( ! $this->template->is_enabled() ) {
            return false;
        }

        $variant = yaymail_sanitize_template_variant( apply_filters( 'yaymail_email_get_variant', '', $order, $args, $this, $template_name ) );
        if ( '' !== $variant ) {
            $this->template = new YayMailTemplate( $template_name, '', $variant );
        }

        return true;
    }

    public function get_title() {
        return $this->title ?? '';
    }

    public function get_recipient() {
        return $this->recipient ?? '';
    }

    public function get_source() {
        return $this->source;
    }

    public function register_shortcodes( $shortcodes ) {
        $this->shortcodes = array_merge( $this->shortcodes, $shortcodes );
    }

    public function get_shortcodes() {
        return $this->shortcodes;
    }

    public function get_root_email() {
        return $this->root_email;
    }

    public function is_existed() {
        return ! empty( $this->id );
    }

    public function maybe_disable_block_email_editor() {
        if ( ! \Automattic\WooCommerce\Utilities\FeaturesUtil::feature_is_enabled( 'block_email_editor' ) ) {
            return;
        }
        if ( ! $this->root_email || ! $this->root_email instanceof \WC_Email ) {
            return;
        }
        // One batched lookup shared by all emails instead of a per-email query at init.
        if ( in_array( $this->id, TemplateModel::get_active_default_template_names(), true ) ) {
            $this->root_email->block_email_editor_enabled = false;
        }
    }
}

```