<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Emails\Templates;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Email Summaries email template class.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.5.4

[7] Fix | Delete

*/

[8] Fix | Delete

class Summary extends General {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Template slug.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.5.4

[14] Fix | Delete

*

[15] Fix | Delete

* @var string

[16] Fix | Delete

*/

[17] Fix | Delete

const TEMPLATE_SLUG = 'summary';

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Initialize class.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 1.8.8

[23] Fix | Delete

*

[24] Fix | Delete

* @param string $message Optional. Message.

[25] Fix | Delete

*/

[26] Fix | Delete

public function __construct( $message = '' ) {

[27] Fix | Delete

[28] Fix | Delete

parent::__construct( $message );

[29] Fix | Delete

[30] Fix | Delete

// Maybe revert (override) the default background color value.

[31] Fix | Delete

$this->set_args( $this->maybe_revert_background_color() );

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Get header image URL from settings.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 1.5.4

[38] Fix | Delete

*

[39] Fix | Delete

* @return array

[40] Fix | Delete

*/

[41] Fix | Delete

protected function get_header_image() {

[42] Fix | Delete

[43] Fix | Delete

$legacy_header_image = $this->maybe_revert_header_image();

[44] Fix | Delete

[45] Fix | Delete

// Bail early, if legacy behavior is enabled.

[46] Fix | Delete

if ( ! empty( $legacy_header_image ) ) {

[47] Fix | Delete

return $legacy_header_image;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

// Set specific WPForms logo width in pixels for MS Outlook and old email clients.

[51] Fix | Delete

return [

[52] Fix | Delete

'url_light' => WPFORMS_PLUGIN_URL . 'assets/images/logo.png',

[53] Fix | Delete

'url_dark' => WPFORMS_PLUGIN_URL . 'assets/images/logo-negative.png',

[54] Fix | Delete

];

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Checks if legacy header image overrides should be applied.

[59] Fix | Delete

*

[60] Fix | Delete

* @since 1.8.8

[61] Fix | Delete

*

[62] Fix | Delete

* @return array

[63] Fix | Delete

*/

[64] Fix | Delete

private function maybe_revert_header_image() {

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* This filter is designed to restore the legacy behavior, reverting the WPForms logo and template background color

[68] Fix | Delete

* to values defined in the WPForms → Settings → Email tab.

[69] Fix | Delete

*

[70] Fix | Delete

* @since 1.8.8

[71] Fix | Delete

*

[72] Fix | Delete

* @param bool $revert_legacy_style_overrides Whether to apply legacy style overrides.

[73] Fix | Delete

*/

[74] Fix | Delete

if ( ! (bool) apply_filters( 'wpforms_emails_templates_summary_revert_legacy_style_overrides', false ) ) {

[75] Fix | Delete

return [];

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

$header_image = wpforms_setting( 'email-header-image' );

[79] Fix | Delete

[80] Fix | Delete

// Bail early, if no custom header image if set.

[81] Fix | Delete

if ( empty( $header_image ) ) {

[82] Fix | Delete

return [];

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

return [ 'url_light' => esc_url( $header_image ) ];

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Checks if legacy background color overrides should be applied.

[90] Fix | Delete

*

[91] Fix | Delete

* @since 1.8.8

[92] Fix | Delete

*

[93] Fix | Delete

* @return array

[94] Fix | Delete

*/

[95] Fix | Delete

private function maybe_revert_background_color() {

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* This filter is designed to restore the legacy behavior, reverting the WPForms logo and template background color

[99] Fix | Delete

* to values defined in the WPForms → Settings → Email tab.

[100] Fix | Delete

*

[101] Fix | Delete

* @since 1.8.8

[102] Fix | Delete

*

[103] Fix | Delete

* @param bool $revert_legacy_style_overrides Whether to apply legacy style overrides.

[104] Fix | Delete

*/

[105] Fix | Delete

if ( ! (bool) apply_filters( 'wpforms_emails_templates_summary_revert_legacy_style_overrides', false ) ) {

[106] Fix | Delete

return [ 'style' => [ 'email_background_color' => '' ] ];

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

return [

[110] Fix | Delete

'style' => [

[111] Fix | Delete

'email_background_color' => wpforms_setting( 'email-background-color', '#e9eaec' ),

[112] Fix | Delete

],

[113] Fix | Delete

];

[114] Fix | Delete

}

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete