* Handles emailing users CSV Export download links.
namespace Automattic\WooCommerce\Admin;
if ( ! defined( 'ABSPATH' ) ) {
if ( ! class_exists( 'WC_Email', false ) ) {
include_once WC_ABSPATH . 'includes/emails/class-wc-email.php';
class ReportCSVEmail extends \WC_Email {
protected $report_labels;
* Report type (e.g. 'customers').
public function __construct() {
$this->id = 'admin_report_export_download';
$this->template_base = WC()->plugin_path() . '/includes/react-admin/emails/';
$this->template_html = 'html-admin-report-export-download.php';
$this->template_plain = 'plain-admin-report-export-download.php';
* Used to customise report email labels.
* @param string[] $labels An array of labels.
* @return string[] An Array of labels.
$this->report_labels = apply_filters(
'woocommerce_report_export_email_labels',
'categories' => __( 'Categories', 'woocommerce' ),
'coupons' => __( 'Coupons', 'woocommerce' ),
'customers' => __( 'Customers', 'woocommerce' ),
'downloads' => __( 'Downloads', 'woocommerce' ),
'orders' => __( 'Orders', 'woocommerce' ),
'products' => __( 'Products', 'woocommerce' ),
'revenue' => __( 'Revenue', 'woocommerce' ),
'stock' => __( 'Stock', 'woocommerce' ),
'taxes' => __( 'Taxes', 'woocommerce' ),
'variations' => __( 'Variations', 'woocommerce' ),
// Call parent constructor.
* This email has no user-facing settings.
public function init_form_fields() {}
* This email has no user-facing settings.
public function init_settings() {}
public function get_email_type() {
return class_exists( 'DOMDocument' ) ? 'html' : 'plain';
public function get_default_heading() {
return __( 'Your Report Download', 'woocommerce' );
public function get_default_subject() {
return __( '[{site_title}]: Your {report_name} Report download is ready', 'woocommerce' );
public function get_content_html() {
return wc_get_template_html(
'report_name' => $this->report_type,
'download_url' => $this->download_url,
'email_heading' => $this->get_heading(),
public function get_content_plain() {
return wc_get_template_html(
'report_name' => $this->report_type,
'download_url' => $this->download_url,
'email_heading' => $this->get_heading(),
* Trigger the sending of this email.
* @param int $user_id User ID to email.
* @param string $report_type The type of report export being emailed.
* @param string $download_url The URL for downloading the report.
public function trigger( $user_id, $report_type, $download_url ) {
$user = new \WP_User( $user_id );
$this->recipient = $user->user_email;
$this->download_url = $download_url;
if ( isset( $this->report_labels[ $report_type ] ) ) {
$this->report_type = $this->report_labels[ $report_type ];
$this->placeholders['{report_name}'] = $this->report_type;