| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002 |
- <?php
- /**
- * Class WC_Email file.
- *
- * @package WooCommerce\Emails
- */
- if ( ! defined( 'ABSPATH' ) ) {
- exit;
- }
- if ( class_exists( 'WC_Email', false ) ) {
- return;
- }
- /**
- * Email Class
- *
- * WooCommerce Email Class which is extended by specific email template classes to add emails to WooCommerce
- *
- * @class WC_Email
- * @version 2.5.0
- * @package WooCommerce/Classes/Emails
- * @extends WC_Settings_API
- */
- class WC_Email extends WC_Settings_API {
- /**
- * Email method ID.
- *
- * @var String
- */
- public $id;
- /**
- * Email method title.
- *
- * @var string
- */
- public $title;
- /**
- * 'yes' if the method is enabled.
- *
- * @var string yes, no
- */
- public $enabled;
- /**
- * Description for the email.
- *
- * @var string
- */
- public $description;
- /**
- * Default heading.
- *
- * Supported for backwards compatibility but we recommend overloading the
- * get_default_x methods instead so localization can be done when needed.
- *
- * @var string
- */
- public $heading = '';
- /**
- * Default subject.
- *
- * Supported for backwards compatibility but we recommend overloading the
- * get_default_x methods instead so localization can be done when needed.
- *
- * @var string
- */
- public $subject = '';
- /**
- * Plain text template path.
- *
- * @var string
- */
- public $template_plain;
- /**
- * HTML template path.
- *
- * @var string
- */
- public $template_html;
- /**
- * Template path.
- *
- * @var string
- */
- public $template_base;
- /**
- * Recipients for the email.
- *
- * @var string
- */
- public $recipient;
- /**
- * Object this email is for, for example a customer, product, or email.
- *
- * @var object|bool
- */
- public $object;
- /**
- * Mime boundary (for multipart emails).
- *
- * @var string
- */
- public $mime_boundary;
- /**
- * Mime boundary header (for multipart emails).
- *
- * @var string
- */
- public $mime_boundary_header;
- /**
- * True when email is being sent.
- *
- * @var bool
- */
- public $sending;
- /**
- * True when the email notification is sent manually only.
- *
- * @var bool
- */
- protected $manual = false;
- /**
- * True when the email notification is sent to customers.
- *
- * @var bool
- */
- protected $customer_email = false;
- /**
- * List of preg* regular expression patterns to search for,
- * used in conjunction with $plain_replace.
- * https://raw.github.com/ushahidi/wp-silcc/master/class.html2text.inc
- *
- * @var array $plain_search
- * @see $plain_replace
- */
- public $plain_search = array(
- "/\r/", // Non-legal carriage return.
- '/&(nbsp|#0*160);/i', // Non-breaking space.
- '/&(quot|rdquo|ldquo|#0*8220|#0*8221|#0*147|#0*148);/i', // Double quotes.
- '/&(apos|rsquo|lsquo|#0*8216|#0*8217);/i', // Single quotes.
- '/>/i', // Greater-than.
- '/</i', // Less-than.
- '/�*38;/i', // Ampersand.
- '/&/i', // Ampersand.
- '/&(copy|#0*169);/i', // Copyright.
- '/&(trade|#0*8482|#0*153);/i', // Trademark.
- '/&(reg|#0*174);/i', // Registered.
- '/&(mdash|#0*151|#0*8212);/i', // mdash.
- '/&(ndash|minus|#0*8211|#0*8722);/i', // ndash.
- '/&(bull|#0*149|#0*8226);/i', // Bullet.
- '/&(pound|#0*163);/i', // Pound sign.
- '/&(euro|#0*8364);/i', // Euro sign.
- '/&(dollar|#0*36);/i', // Dollar sign.
- '/&[^&\s;]+;/i', // Unknown/unhandled entities.
- '/[ ]{2,}/', // Runs of spaces, post-handling.
- );
- /**
- * List of pattern replacements corresponding to patterns searched.
- *
- * @var array $plain_replace
- * @see $plain_search
- */
- public $plain_replace = array(
- '', // Non-legal carriage return.
- ' ', // Non-breaking space.
- '"', // Double quotes.
- "'", // Single quotes.
- '>', // Greater-than.
- '<', // Less-than.
- '&', // Ampersand.
- '&', // Ampersand.
- '(c)', // Copyright.
- '(tm)', // Trademark.
- '(R)', // Registered.
- '--', // mdash.
- '-', // ndash.
- '*', // Bullet.
- '£', // Pound sign.
- 'EUR', // Euro sign. € ?.
- '$', // Dollar sign.
- '', // Unknown/unhandled entities.
- ' ', // Runs of spaces, post-handling.
- );
- /**
- * Strings to find/replace in subjects/headings.
- *
- * @var array
- */
- protected $placeholders = array();
- /**
- * Strings to find in subjects/headings.
- *
- * @deprecated 3.2.0 in favour of placeholders
- * @var array
- */
- public $find = array();
- /**
- * Strings to replace in subjects/headings.
- *
- * @deprecated 3.2.0 in favour of placeholders
- * @var array
- */
- public $replace = array();
- /**
- * Constructor.
- */
- public function __construct() {
- // Find/replace.
- if ( empty( $this->placeholders ) ) {
- $this->placeholders = array(
- '{site_title}' => $this->get_blogname(),
- );
- }
- // Init settings.
- $this->init_form_fields();
- $this->init_settings();
- // Default template base if not declared in child constructor.
- if ( is_null( $this->template_base ) ) {
- $this->template_base = WC()->plugin_path() . '/templates/';
- }
- $this->email_type = $this->get_option( 'email_type' );
- $this->enabled = $this->get_option( 'enabled' );
- add_action( 'phpmailer_init', array( $this, 'handle_multipart' ) );
- add_action( 'woocommerce_update_options_email_' . $this->id, array( $this, 'process_admin_options' ) );
- }
- /**
- * Handle multipart mail.
- *
- * @param PHPMailer $mailer PHPMailer object.
- * @return PHPMailer
- */
- public function handle_multipart( $mailer ) {
- if ( $this->sending && 'multipart' === $this->get_email_type() ) {
- $mailer->AltBody = wordwrap( // phpcs:ignore WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
- preg_replace( $this->plain_search, $this->plain_replace, strip_tags( $this->get_content_plain() ) )
- );
- $this->sending = false;
- }
- return $mailer;
- }
- /**
- * Format email string.
- *
- * @param mixed $string Text to replace placeholders in.
- * @return string
- */
- public function format_string( $string ) {
- $find = array_keys( $this->placeholders );
- $replace = array_values( $this->placeholders );
- // If using legacy find replace, add those to our find/replace arrays first. @todo deprecate in 4.0.0.
- $find = array_merge( (array) $this->find, $find );
- $replace = array_merge( (array) $this->replace, $replace );
- // Take care of blogname which is no longer defined as a valid placeholder.
- $find[] = '{blogname}';
- $replace[] = $this->get_blogname();
- // If using the older style filters for find and replace, ensure the array is associative and then pass through filters. @todo deprecate in 4.0.0.
- if ( has_filter( 'woocommerce_email_format_string_replace' ) || has_filter( 'woocommerce_email_format_string_find' ) ) {
- $legacy_find = $this->find;
- $legacy_replace = $this->replace;
- foreach ( $this->placeholders as $find => $replace ) {
- $legacy_key = sanitize_title( str_replace( '_', '-', trim( $find, '{}' ) ) );
- $legacy_find[ $legacy_key ] = $find;
- $legacy_replace[ $legacy_key ] = $replace;
- }
- $string = str_replace( apply_filters( 'woocommerce_email_format_string_find', $legacy_find, $this ), apply_filters( 'woocommerce_email_format_string_replace', $legacy_replace, $this ), $string );
- }
- /**
- * Filter for main find/replace.
- *
- * @since 3.2.0
- */
- return apply_filters( 'woocommerce_email_format_string', str_replace( $find, $replace, $string ), $this );
- }
- /**
- * Set the locale to the store locale for customer emails to make sure emails are in the store language.
- */
- public function setup_locale() {
- if ( $this->is_customer_email() && apply_filters( 'woocommerce_email_setup_locale', true ) ) {
- wc_switch_to_site_locale();
- }
- }
- /**
- * Restore the locale to the default locale. Use after finished with setup_locale.
- */
- public function restore_locale() {
- if ( $this->is_customer_email() && apply_filters( 'woocommerce_email_restore_locale', true ) ) {
- wc_restore_locale();
- }
- }
- /**
- * Get email subject.
- *
- * @since 3.1.0
- * @return string
- */
- public function get_default_subject() {
- return $this->subject;
- }
- /**
- * Get email heading.
- *
- * @since 3.1.0
- * @return string
- */
- public function get_default_heading() {
- return $this->heading;
- }
- /**
- * Get email subject.
- *
- * @return string
- */
- public function get_subject() {
- return apply_filters( 'woocommerce_email_subject_' . $this->id, $this->format_string( $this->get_option( 'subject', $this->get_default_subject() ) ), $this->object );
- }
- /**
- * Get email heading.
- *
- * @return string
- */
- public function get_heading() {
- return apply_filters( 'woocommerce_email_heading_' . $this->id, $this->format_string( $this->get_option( 'heading', $this->get_default_heading() ) ), $this->object );
- }
- /**
- * Get valid recipients.
- *
- * @return string
- */
- public function get_recipient() {
- $recipient = apply_filters( 'woocommerce_email_recipient_' . $this->id, $this->recipient, $this->object );
- $recipients = array_map( 'trim', explode( ',', $recipient ) );
- $recipients = array_filter( $recipients, 'is_email' );
- return implode( ', ', $recipients );
- }
- /**
- * Get email headers.
- *
- * @return string
- */
- public function get_headers() {
- $header = 'Content-Type: ' . $this->get_content_type() . "\r\n";
- if ( 'new_order' === $this->id && $this->object && $this->object->get_billing_email() && ( $this->object->get_billing_first_name() || $this->object->get_billing_last_name() ) ) {
- $header .= 'Reply-to: ' . $this->object->get_billing_first_name() . ' ' . $this->object->get_billing_last_name() . ' <' . $this->object->get_billing_email() . ">\r\n";
- }
- return apply_filters( 'woocommerce_email_headers', $header, $this->id, $this->object );
- }
- /**
- * Get email attachments.
- *
- * @return array
- */
- public function get_attachments() {
- return apply_filters( 'woocommerce_email_attachments', array(), $this->id, $this->object );
- }
- /**
- * Return email type.
- *
- * @return string
- */
- public function get_email_type() {
- return $this->email_type && class_exists( 'DOMDocument' ) ? $this->email_type : 'plain';
- }
- /**
- * Get email content type.
- *
- * @return string
- */
- public function get_content_type() {
- switch ( $this->get_email_type() ) {
- case 'html':
- return 'text/html';
- case 'multipart':
- return 'multipart/alternative';
- default:
- return 'text/plain';
- }
- }
- /**
- * Return the email's title
- *
- * @return string
- */
- public function get_title() {
- return apply_filters( 'woocommerce_email_title', $this->title, $this );
- }
- /**
- * Return the email's description
- *
- * @return string
- */
- public function get_description() {
- return apply_filters( 'woocommerce_email_description', $this->description, $this );
- }
- /**
- * Proxy to parent's get_option and attempt to localize the result using gettext.
- *
- * @param string $key Option key.
- * @param mixed $empty_value Value to use when option is empty.
- * @return string
- */
- public function get_option( $key, $empty_value = null ) {
- $value = parent::get_option( $key, $empty_value );
- return apply_filters( 'woocommerce_email_get_option', $value, $this, $value, $key, $empty_value );
- }
- /**
- * Checks if this email is enabled and will be sent.
- *
- * @return bool
- */
- public function is_enabled() {
- return apply_filters( 'woocommerce_email_enabled_' . $this->id, 'yes' === $this->enabled, $this->object );
- }
- /**
- * Checks if this email is manually sent
- *
- * @return bool
- */
- public function is_manual() {
- return $this->manual;
- }
- /**
- * Checks if this email is customer focussed.
- *
- * @return bool
- */
- public function is_customer_email() {
- return $this->customer_email;
- }
- /**
- * Get WordPress blog name.
- *
- * @return string
- */
- public function get_blogname() {
- return wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
- }
- /**
- * Get email content.
- *
- * @return string
- */
- public function get_content() {
- $this->sending = true;
- if ( 'plain' === $this->get_email_type() ) {
- $email_content = wordwrap( preg_replace( $this->plain_search, $this->plain_replace, strip_tags( $this->get_content_plain() ) ), 70 );
- } else {
- $email_content = $this->get_content_html();
- }
- return $email_content;
- }
- /**
- * Apply inline styles to dynamic content.
- *
- * @param string|null $content Content that will receive inline styles.
- * @return string
- */
- public function style_inline( $content ) {
- // make sure we only inline CSS for html emails.
- if ( in_array( $this->get_content_type(), array( 'text/html', 'multipart/alternative' ), true ) && class_exists( 'DOMDocument' ) ) {
- ob_start();
- wc_get_template( 'emails/email-styles.php' );
- $css = apply_filters( 'woocommerce_email_styles', ob_get_clean() );
- // apply CSS styles inline for picky email clients.
- try {
- $emogrifier = new Emogrifier( $content, $css );
- $content = $emogrifier->emogrify();
- } catch ( Exception $e ) {
- $logger = wc_get_logger();
- $logger->error( $e->getMessage(), array( 'source' => 'emogrifier' ) );
- }
- }
- return $content;
- }
- /**
- * Get the email content in plain text format.
- *
- * @return string
- */
- public function get_content_plain() {
- return ''; }
- /**
- * Get the email content in HTML format.
- *
- * @return string
- */
- public function get_content_html() {
- return ''; }
- /**
- * Get the from name for outgoing emails.
- *
- * @return string
- */
- public function get_from_name() {
- $from_name = apply_filters( 'woocommerce_email_from_name', get_option( 'woocommerce_email_from_name' ), $this );
- return wp_specialchars_decode( esc_html( $from_name ), ENT_QUOTES );
- }
- /**
- * Get the from address for outgoing emails.
- *
- * @return string
- */
- public function get_from_address() {
- $from_address = apply_filters( 'woocommerce_email_from_address', get_option( 'woocommerce_email_from_address' ), $this );
- return sanitize_email( $from_address );
- }
- /**
- * Send an email.
- *
- * @param string $to Email to.
- * @param string $subject Email subject.
- * @param string $message Email message.
- * @param string $headers Email headers.
- * @param array $attachments Email attachments.
- * @return bool success
- */
- public function send( $to, $subject, $message, $headers, $attachments ) {
- add_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
- add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
- add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
- $message = apply_filters( 'woocommerce_mail_content', $this->style_inline( $message ) );
- $return = wp_mail( $to, $subject, $message, $headers, $attachments );
- remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
- remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
- remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
- return $return;
- }
- /**
- * Initialise Settings Form Fields - these are generic email options most will use.
- */
- public function init_form_fields() {
- $this->form_fields = array(
- 'enabled' => array(
- 'title' => __( 'Enable/Disable', 'woocommerce' ),
- 'type' => 'checkbox',
- 'label' => __( 'Enable this email notification', 'woocommerce' ),
- 'default' => 'yes',
- ),
- 'subject' => array(
- 'title' => __( 'Subject', 'woocommerce' ),
- 'type' => 'text',
- 'desc_tip' => true,
- /* translators: %s: list of placeholders */
- 'description' => sprintf( __( 'Available placeholders: %s', 'woocommerce' ), '<code>' . implode( '</code>, <code>', array_keys( $this->placeholders ) ) . '</code>' ),
- 'placeholder' => $this->get_default_subject(),
- 'default' => '',
- ),
- 'heading' => array(
- 'title' => __( 'Email heading', 'woocommerce' ),
- 'type' => 'text',
- 'desc_tip' => true,
- /* translators: %s: list of placeholders */
- 'description' => sprintf( __( 'Available placeholders: %s', 'woocommerce' ), '<code>' . implode( '</code>, <code>', array_keys( $this->placeholders ) ) . '</code>' ),
- 'placeholder' => $this->get_default_heading(),
- 'default' => '',
- ),
- 'email_type' => array(
- 'title' => __( 'Email type', 'woocommerce' ),
- 'type' => 'select',
- 'description' => __( 'Choose which format of email to send.', 'woocommerce' ),
- 'default' => 'html',
- 'class' => 'email_type wc-enhanced-select',
- 'options' => $this->get_email_type_options(),
- 'desc_tip' => true,
- ),
- );
- }
- /**
- * Email type options.
- *
- * @return array
- */
- public function get_email_type_options() {
- $types = array( 'plain' => __( 'Plain text', 'woocommerce' ) );
- if ( class_exists( 'DOMDocument' ) ) {
- $types['html'] = __( 'HTML', 'woocommerce' );
- $types['multipart'] = __( 'Multipart', 'woocommerce' );
- }
- return $types;
- }
- /**
- * Admin Panel Options Processing.
- */
- public function process_admin_options() {
- // Save regular options.
- parent::process_admin_options();
- $post_data = $this->get_post_data();
- // Save templates.
- if ( isset( $post_data['template_html_code'] ) ) {
- $this->save_template( $post_data['template_html_code'], $this->template_html );
- }
- if ( isset( $post_data['template_plain_code'] ) ) {
- $this->save_template( $post_data['template_plain_code'], $this->template_plain );
- }
- }
- /**
- * Get template.
- *
- * @param string $type Template type. Can be either 'template_html' or 'template_plain'.
- * @return string
- */
- public function get_template( $type ) {
- $type = basename( $type );
- if ( 'template_html' === $type ) {
- return $this->template_html;
- } elseif ( 'template_plain' === $type ) {
- return $this->template_plain;
- }
- return '';
- }
- /**
- * Save the email templates.
- *
- * @since 2.4.0
- * @param string $template_code Template code.
- * @param string $template_path Template path.
- */
- protected function save_template( $template_code, $template_path ) {
- if ( current_user_can( 'edit_themes' ) && ! empty( $template_code ) && ! empty( $template_path ) ) {
- $saved = false;
- $file = get_stylesheet_directory() . '/' . WC()->template_path() . $template_path;
- $code = wp_unslash( $template_code );
- if ( is_writeable( $file ) ) { // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writeable
- $f = fopen( $file, 'w+' );
- if ( false !== $f ) {
- fwrite( $f, $code );
- fclose( $f );
- $saved = true;
- }
- }
- if ( ! $saved ) {
- $redirect = add_query_arg( 'wc_error', urlencode( __( 'Could not write to template file.', 'woocommerce' ) ) );
- wp_safe_redirect( $redirect );
- exit;
- }
- }
- }
- /**
- * Get the template file in the current theme.
- *
- * @param string $template Template name.
- *
- * @return string
- */
- public function get_theme_template_file( $template ) {
- return get_stylesheet_directory() . '/' . apply_filters( 'woocommerce_template_directory', 'woocommerce', $template ) . '/' . $template;
- }
- /**
- * Move template action.
- *
- * @param string $template_type Template type.
- */
- protected function move_template_action( $template_type ) {
- $template = $this->get_template( $template_type );
- if ( ! empty( $template ) ) {
- $theme_file = $this->get_theme_template_file( $template );
- if ( wp_mkdir_p( dirname( $theme_file ) ) && ! file_exists( $theme_file ) ) {
- // Locate template file.
- $core_file = $this->template_base . $template;
- $template_file = apply_filters( 'woocommerce_locate_core_template', $core_file, $template, $this->template_base, $this->id );
- // Copy template file.
- copy( $template_file, $theme_file );
- /**
- * Action hook fired after copying email template file.
- *
- * @param string $template_type The copied template type
- * @param string $email The email object
- */
- do_action( 'woocommerce_copy_email_template', $template_type, $this );
- ?>
- <div class="updated">
- <p><?php echo esc_html__( 'Template file copied to theme.', 'woocommerce' ); ?></p>
- </div>
- <?php
- }
- }
- }
- /**
- * Delete template action.
- *
- * @param string $template_type Template type.
- */
- protected function delete_template_action( $template_type ) {
- $template = $this->get_template( $template_type );
- if ( $template ) {
- if ( ! empty( $template ) ) {
- $theme_file = $this->get_theme_template_file( $template );
- if ( file_exists( $theme_file ) ) {
- unlink( $theme_file ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink
- /**
- * Action hook fired after deleting template file.
- *
- * @param string $template The deleted template type
- * @param string $email The email object
- */
- do_action( 'woocommerce_delete_email_template', $template_type, $this );
- ?>
- <div class="updated">
- <p><?php echo esc_html__( 'Template file deleted from theme.', 'woocommerce' ); ?></p>
- </div>
- <?php
- }
- }
- }
- }
- /**
- * Admin actions.
- */
- protected function admin_actions() {
- // Handle any actions.
- if (
- ( ! empty( $this->template_html ) || ! empty( $this->template_plain ) )
- && ( ! empty( $_GET['move_template'] ) || ! empty( $_GET['delete_template'] ) )
- && 'GET' === $_SERVER['REQUEST_METHOD'] // phpcs:ignore WordPress.VIP.ValidatedSanitizedInput.InputNotValidated
- ) {
- if ( empty( $_GET['_wc_email_nonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_GET['_wc_email_nonce'] ) ), 'woocommerce_email_template_nonce' ) ) {
- wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) );
- }
- if ( ! current_user_can( 'edit_themes' ) ) {
- wp_die( esc_html__( 'You don’t have permission to do this.', 'woocommerce' ) );
- }
- if ( ! empty( $_GET['move_template'] ) ) {
- $this->move_template_action( wc_clean( wp_unslash( $_GET['move_template'] ) ) );
- }
- if ( ! empty( $_GET['delete_template'] ) ) {
- $this->delete_template_action( wc_clean( wp_unslash( $_GET['delete_template'] ) ) );
- }
- }
- }
- /**
- * Admin Options.
- *
- * Setup the email settings screen.
- * Override this in your email.
- *
- * @since 1.0.0
- */
- public function admin_options() {
- // Do admin actions.
- $this->admin_actions();
- ?>
- <h2><?php echo esc_html( $this->get_title() ); ?> <?php wc_back_link( __( 'Return to emails', 'woocommerce' ), admin_url( 'admin.php?page=wc-settings&tab=email' ) ); ?></h2>
- <?php echo wpautop( wp_kses_post( $this->get_description() ) ); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped ?>
- <?php
- /**
- * Action hook fired before displaying email settings.
- *
- * @param string $email The email object
- */
- do_action( 'woocommerce_email_settings_before', $this );
- ?>
- <table class="form-table">
- <?php $this->generate_settings_html(); ?>
- </table>
- <?php
- /**
- * Action hook fired after displaying email settings.
- *
- * @param string $email The email object
- */
- do_action( 'woocommerce_email_settings_after', $this );
- ?>
- <?php
- if ( current_user_can( 'edit_themes' ) && ( ! empty( $this->template_html ) || ! empty( $this->template_plain ) ) ) {
- ?>
- <div id="template">
- <?php
- $templates = array(
- 'template_html' => __( 'HTML template', 'woocommerce' ),
- 'template_plain' => __( 'Plain text template', 'woocommerce' ),
- );
- foreach ( $templates as $template_type => $title ) :
- $template = $this->get_template( $template_type );
- if ( empty( $template ) ) {
- continue;
- }
- $local_file = $this->get_theme_template_file( $template );
- $core_file = $this->template_base . $template;
- $template_file = apply_filters( 'woocommerce_locate_core_template', $core_file, $template, $this->template_base, $this->id );
- $template_dir = apply_filters( 'woocommerce_template_directory', 'woocommerce', $template );
- ?>
- <div class="template <?php echo esc_attr( $template_type ); ?>">
- <h4><?php echo wp_kses_post( $title ); ?></h4>
- <?php if ( file_exists( $local_file ) ) : ?>
- <p>
- <a href="#" class="button toggle_editor"></a>
- <?php if ( is_writable( $local_file ) ) : // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writable ?>
- <a href="<?php echo esc_url( wp_nonce_url( remove_query_arg( array( 'move_template', 'saved' ), add_query_arg( 'delete_template', $template_type ) ), 'woocommerce_email_template_nonce', '_wc_email_nonce' ) ); ?>" class="delete_template button">
- <?php esc_html_e( 'Delete template file', 'woocommerce' ); ?>
- </a>
- <?php endif; ?>
- <?php
- /* translators: %s: Path to template file */
- printf( esc_html__( 'This template has been overridden by your theme and can be found in: %s.', 'woocommerce' ), '<code>' . esc_html( trailingslashit( basename( get_stylesheet_directory() ) ) . $template_dir . '/' . $template ) . '</code>' );
- ?>
- </p>
- <div class="editor" style="display:none">
- <textarea class="code" cols="25" rows="20"
- <?php
- if ( ! is_writable( $local_file ) ) : // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writable
- ?>
- readonly="readonly" disabled="disabled"
- <?php else : ?>
- data-name="<?php echo esc_attr( $template_type ) . '_code'; ?>"<?php endif; ?>><?php echo esc_html( file_get_contents( $local_file ) ); ?></textarea>
- </div>
- <?php elseif ( file_exists( $template_file ) ) : ?>
- <p>
- <a href="#" class="button toggle_editor"></a>
- <?php
- $emails_dir = get_stylesheet_directory() . '/' . $template_dir . '/emails';
- $templates_dir = get_stylesheet_directory() . '/' . $template_dir;
- $theme_dir = get_stylesheet_directory();
- if ( is_dir( $emails_dir ) ) {
- $target_dir = $emails_dir;
- } elseif ( is_dir( $templates_dir ) ) {
- $target_dir = $templates_dir;
- } else {
- $target_dir = $theme_dir;
- }
- if ( is_writable( $target_dir ) ) : // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writable
- ?>
- <a href="<?php echo esc_url( wp_nonce_url( remove_query_arg( array( 'delete_template', 'saved' ), add_query_arg( 'move_template', $template_type ) ), 'woocommerce_email_template_nonce', '_wc_email_nonce' ) ); ?>" class="button">
- <?php esc_html_e( 'Copy file to theme', 'woocommerce' ); ?>
- </a>
- <?php endif; ?>
- <?php
- /* translators: 1: Path to template file 2: Path to theme folder */
- printf( esc_html__( 'To override and edit this email template copy %1$s to your theme folder: %2$s.', 'woocommerce' ), '<code>' . esc_html( plugin_basename( $template_file ) ) . '</code>', '<code>' . esc_html( trailingslashit( basename( get_stylesheet_directory() ) ) . $template_dir . '/' . $template ) . '</code>' );
- ?>
- </p>
- <div class="editor" style="display:none">
- <textarea class="code" readonly="readonly" disabled="disabled" cols="25" rows="20"><?php echo esc_html( file_get_contents( $template_file ) ); ?></textarea>
- </div>
- <?php else : ?>
- <p><?php esc_html_e( 'File was not found.', 'woocommerce' ); ?></p>
- <?php endif; ?>
- </div>
- <?php endforeach; ?>
- </div>
- <?php
- wc_enqueue_js(
- "jQuery( 'select.email_type' ).change( function() {
- var val = jQuery( this ).val();
- jQuery( '.template_plain, .template_html' ).show();
- if ( val != 'multipart' && val != 'html' ) {
- jQuery('.template_html').hide();
- }
- if ( val != 'multipart' && val != 'plain' ) {
- jQuery('.template_plain').hide();
- }
- }).change();
- var view = '" . esc_js( __( 'View template', 'woocommerce' ) ) . "';
- var hide = '" . esc_js( __( 'Hide template', 'woocommerce' ) ) . "';
- jQuery( 'a.toggle_editor' ).text( view ).toggle( function() {
- jQuery( this ).text( hide ).closest(' .template' ).find( '.editor' ).slideToggle();
- return false;
- }, function() {
- jQuery( this ).text( view ).closest( '.template' ).find( '.editor' ).slideToggle();
- return false;
- } );
- jQuery( 'a.delete_template' ).click( function() {
- if ( window.confirm('" . esc_js( __( 'Are you sure you want to delete this template file?', 'woocommerce' ) ) . "') ) {
- return true;
- }
- return false;
- });
- jQuery( '.editor textarea' ).change( function() {
- var name = jQuery( this ).attr( 'data-name' );
- if ( name ) {
- jQuery( this ).attr( 'name', name );
- }
- });"
- );
- }
- }
- }
|