woocommerce/includes/admin/settings/class-wc-settings-emails.php

308 lines
10 KiB
PHP
Raw Normal View History

2013-07-26 14:36:28 +00:00
<?php
/**
* WooCommerce Email Settings
*
* @author WooThemes
* @category Admin
* @package WooCommerce/Admin
2013-07-26 14:36:28 +00:00
* @version 2.1.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
2013-07-26 14:36:28 +00:00
2017-02-16 11:46:01 +00:00
if ( ! class_exists( 'WC_Settings_Emails', false ) ) :
2013-07-26 14:36:28 +00:00
/**
2015-11-03 13:31:20 +00:00
* WC_Settings_Emails.
2013-07-26 14:36:28 +00:00
*/
class WC_Settings_Emails extends WC_Settings_Page {
/**
* Constructor.
*/
public function __construct() {
$this->id = 'email';
$this->label = __( 'Emails', 'woocommerce' );
2013-07-26 14:36:28 +00:00
add_action( 'woocommerce_admin_field_email_notification', array( $this, 'email_notification_setting' ) );
parent::__construct();
2013-07-26 14:36:28 +00:00
}
/**
2015-11-03 13:31:20 +00:00
* Get sections.
2013-07-26 14:36:28 +00:00
*
* @return array
*/
public function get_sections() {
$sections = array(
'' => __( 'Email options', 'woocommerce' ),
2013-07-26 14:36:28 +00:00
);
return apply_filters( 'woocommerce_get_sections_' . $this->id, $sections );
2013-07-26 14:36:28 +00:00
}
/**
2015-11-03 13:31:20 +00:00
* Get settings array.
2013-07-26 14:36:28 +00:00
*
* @return array
*/
public function get_settings() {
$settings = apply_filters( 'woocommerce_email_settings', array(
2013-07-26 14:36:28 +00:00
array( 'title' => __( 'Email notifications', 'woocommerce' ), 'desc' => __( 'Email notifications sent from WooCommerce are listed below. Click on an email to configure it.', 'woocommerce' ), 'type' => 'title', 'id' => 'email_notification_settings' ),
array( 'type' => 'email_notification' ),
array( 'type' => 'sectionend', 'id' => 'email_notification_settings' ),
2013-07-26 14:36:28 +00:00
array( 'type' => 'sectionend', 'id' => 'email_recipient_options' ),
array( 'title' => __( 'Email sender options', 'woocommerce' ), 'type' => 'title', 'desc' => '', 'id' => 'email_options' ),
2013-07-26 14:36:28 +00:00
array(
'title' => __( '"From" name', 'woocommerce' ),
'desc' => __( 'How the sender name appears in outgoing WooCommerce emails.', 'woocommerce' ),
'id' => 'woocommerce_email_from_name',
'type' => 'text',
'css' => 'min-width:300px;',
'default' => esc_attr( get_bloginfo( 'name', 'display' ) ),
'autoload' => false,
'desc_tip' => true,
2013-07-26 14:36:28 +00:00
),
array(
'title' => __( '"From" address', 'woocommerce' ),
'desc' => __( 'How the sender email appears in outgoing WooCommerce emails.', 'woocommerce' ),
'id' => 'woocommerce_email_from_address',
'type' => 'email',
2013-07-26 14:36:28 +00:00
'custom_attributes' => array(
'multiple' => 'multiple',
2013-07-26 14:36:28 +00:00
),
'css' => 'min-width:300px;',
'default' => get_option( 'admin_email' ),
'autoload' => false,
'desc_tip' => true,
2013-07-26 14:36:28 +00:00
),
array( 'type' => 'sectionend', 'id' => 'email_options' ),
array( 'title' => __( 'Email template', 'woocommerce' ), 'type' => 'title', 'desc' => sprintf( __( 'This section lets you customize the WooCommerce emails. <a href="%s" target="_blank">Click here to preview your email template</a>.', 'woocommerce' ), wp_nonce_url( admin_url( '?preview_woocommerce_mail=true' ), 'preview-mail' ) ), 'id' => 'email_template_options' ),
2013-07-26 14:36:28 +00:00
array(
'title' => __( 'Header image', 'woocommerce' ),
'desc' => __( 'URL to an image you want to show in the email header. Upload images using the media uploader (Admin > Media).', 'woocommerce' ),
'id' => 'woocommerce_email_header_image',
'type' => 'text',
'css' => 'min-width:300px;',
'placeholder' => __( 'N/A', 'woocommerce' ),
'default' => '',
'autoload' => false,
'desc_tip' => true,
2013-07-26 14:36:28 +00:00
),
array(
'title' => __( 'Footer text', 'woocommerce' ),
'desc' => __( 'The text to appear in the footer of WooCommerce emails.', 'woocommerce' ),
'id' => 'woocommerce_email_footer_text',
'css' => 'width:300px; height: 75px;',
'placeholder' => __( 'N/A', 'woocommerce' ),
'type' => 'textarea',
2016-10-29 17:32:38 +00:00
/* translators: %s: site name */
'default' => sprintf( __( '%s - Powered by WooCommerce', 'woocommerce' ), get_bloginfo( 'name', 'display' ) ),
'autoload' => false,
'desc_tip' => true,
2013-07-26 14:36:28 +00:00
),
array(
2016-12-19 11:28:09 +00:00
'title' => __( 'Base color', 'woocommerce' ),
2016-10-29 17:32:38 +00:00
/* translators: %s: default color */
2016-12-19 11:28:09 +00:00
'desc' => sprintf( __( 'The base color for WooCommerce email templates. Default %s.', 'woocommerce' ), '<code>#96588a</code>' ),
'id' => 'woocommerce_email_base_color',
'type' => 'color',
'css' => 'width:6em;',
'default' => '#96588a',
'autoload' => false,
'desc_tip' => true,
2013-07-26 14:36:28 +00:00
),
array(
2016-12-19 11:28:09 +00:00
'title' => __( 'Background color', 'woocommerce' ),
2016-10-29 17:32:38 +00:00
/* translators: %s: default color */
2016-12-19 11:28:09 +00:00
'desc' => sprintf( __( 'The background color for WooCommerce email templates. Default %s.', 'woocommerce' ), '<code>#f7f7f7</code>' ),
'id' => 'woocommerce_email_background_color',
'type' => 'color',
'css' => 'width:6em;',
'default' => '#f7f7f7',
'autoload' => false,
'desc_tip' => true,
2013-07-26 14:36:28 +00:00
),
array(
2016-12-19 11:28:09 +00:00
'title' => __( 'Body background color', 'woocommerce' ),
2016-10-29 17:32:38 +00:00
/* translators: %s: default color */
2016-12-19 11:28:09 +00:00
'desc' => sprintf( __( 'The main body background color. Default %s.', 'woocommerce' ), '<code>#ffffff</code>' ),
'id' => 'woocommerce_email_body_background_color',
'type' => 'color',
'css' => 'width:6em;',
'default' => '#ffffff',
'autoload' => false,
'desc_tip' => true,
2013-07-26 14:36:28 +00:00
),
array(
2016-12-19 11:28:09 +00:00
'title' => __( 'Body text color', 'woocommerce' ),
2016-10-29 17:32:38 +00:00
/* translators: %s: default color */
2016-12-19 11:28:09 +00:00
'desc' => sprintf( __( 'The main body text color. Default %s.', 'woocommerce' ), '<code>#3c3c3c</code>' ),
'id' => 'woocommerce_email_text_color',
'type' => 'color',
'css' => 'width:6em;',
'default' => '#3c3c3c',
'autoload' => false,
'desc_tip' => true,
2013-07-26 14:36:28 +00:00
),
array( 'type' => 'sectionend', 'id' => 'email_template_options' ),
2013-07-26 14:36:28 +00:00
) );
return apply_filters( 'woocommerce_get_settings_' . $this->id, $settings );
2013-07-26 14:36:28 +00:00
}
/**
2015-11-03 13:31:20 +00:00
* Output the settings.
2013-07-26 14:36:28 +00:00
*/
public function output() {
global $current_section;
// Define emails that can be customised here
$mailer = WC()->mailer();
$email_templates = $mailer->get_emails();
2013-07-26 14:36:28 +00:00
if ( $current_section ) {
foreach ( $email_templates as $email_key => $email ) {
if ( strtolower( $email_key ) == $current_section ) {
2013-07-26 14:36:28 +00:00
$email->admin_options();
break;
}
}
} else {
2013-07-26 14:36:28 +00:00
$settings = $this->get_settings();
WC_Admin_Settings::output_fields( $settings );
}
}
/**
2015-11-03 13:31:20 +00:00
* Save settings.
2013-07-26 14:36:28 +00:00
*/
public function save() {
global $current_section;
if ( ! $current_section ) {
WC_Admin_Settings::save_fields( $this->get_settings() );
2013-07-26 14:36:28 +00:00
} else {
$wc_emails = WC_Emails::instance();
2014-12-12 12:48:55 +00:00
if ( in_array( $current_section, array_map( 'sanitize_title', array_keys( $wc_emails->get_emails() ) ) ) ) {
foreach ( $wc_emails->get_emails() as $email_id => $email ) {
2016-09-09 00:14:28 +00:00
if ( sanitize_title( $email_id ) === $current_section ) {
do_action( 'woocommerce_update_options_' . $this->id . '_' . $email->id );
}
}
2013-07-26 14:36:28 +00:00
} else {
do_action( 'woocommerce_update_options_' . $this->id . '_' . $current_section );
}
}
}
/**
2015-12-16 06:25:17 +00:00
* Output email notification settings.
*/
public function email_notification_setting() {
// Define emails that can be customised here
$mailer = WC()->mailer();
$email_templates = $mailer->get_emails();
?>
<tr valign="top">
<td class="wc_emails_wrapper" colspan="2">
<table class="wc_emails widefat" cellspacing="0">
<thead>
<tr>
<?php
$columns = apply_filters( 'woocommerce_email_setting_columns', array(
'status' => '',
'name' => __( 'Email', 'woocommerce' ),
'email_type' => __( 'Content type', 'woocommerce' ),
2015-11-03 15:40:10 +00:00
'recipient' => __( 'Recipient(s)', 'woocommerce' ),
'actions' => '',
) );
foreach ( $columns as $key => $column ) {
echo '<th class="wc-email-settings-table-' . esc_attr( $key ) . '">' . esc_html( $column ) . '</th>';
}
?>
</tr>
</thead>
<tbody>
<?php
foreach ( $email_templates as $email_key => $email ) {
echo '<tr>';
foreach ( $columns as $key => $column ) {
switch ( $key ) {
case 'name' :
echo '<td class="wc-email-settings-table-' . esc_attr( $key ) . '">
2015-12-16 06:25:17 +00:00
<a href="' . admin_url( 'admin.php?page=wc-settings&tab=email&section=' . strtolower( $email_key ) ) . '">' . $email->get_title() . '</a>
2015-11-03 16:12:13 +00:00
' . wc_help_tip( $email->get_description() ) . '
</td>';
break;
case 'recipient' :
echo '<td class="wc-email-settings-table-' . esc_attr( $key ) . '">
2015-11-03 15:40:10 +00:00
' . esc_html( $email->is_customer_email() ? __( 'Customer', 'woocommerce' ) : $email->get_recipient() ) . '
</td>';
break;
case 'status' :
echo '<td class="wc-email-settings-table-' . esc_attr( $key ) . '">';
2015-11-03 15:40:10 +00:00
if ( $email->is_manual() ) {
echo '<span class="status-manual tips" data-tip="' . esc_attr__( 'Manually sent', 'woocommerce' ) . '">' . esc_html__( 'Manual', 'woocommerce' ) . '</span>';
2015-11-03 15:40:10 +00:00
} elseif ( $email->is_enabled() ) {
echo '<span class="status-enabled tips" data-tip="' . esc_attr__( 'Enabled', 'woocommerce' ) . '">' . esc_html__( 'Yes', 'woocommerce' ) . '</span>';
2015-11-03 15:40:10 +00:00
} else {
echo '<span class="status-disabled tips" data-tip="' . esc_attr__( 'Disabled', 'woocommerce' ) . '">-</span>';
2015-11-03 15:40:10 +00:00
}
echo '</td>';
break;
case 'email_type' :
echo '<td class="wc-email-settings-table-' . esc_attr( $key ) . '">
2015-11-03 15:40:10 +00:00
' . esc_html( $email->get_content_type() ) . '
</td>';
break;
case 'actions' :
echo '<td class="wc-email-settings-table-' . esc_attr( $key ) . '">
<a class="button alignright tips" data-tip="' . esc_attr__( 'Configure', 'woocommerce' ) . '" href="' . admin_url( 'admin.php?page=wc-settings&tab=email&section=' . strtolower( $email_key ) ) . '">' . esc_html__( 'Configure', 'woocommerce' ) . '</a>
</td>';
break;
default :
do_action( 'woocommerce_email_setting_column_' . $key, $email );
break;
}
}
echo '</tr>';
}
?>
</tbody>
</table>
</td>
</tr>
<?php
}
2013-07-26 14:36:28 +00:00
}
endif;
return new WC_Settings_Emails();