Added branded emails for non html and GF Notifications

includes/classes/BrandedEmails.php

@@ -0,0 +1,119 @@
+<?php
+/**
+ * Add branding email templates to site emails.
+ *
+ * @package         Orbit
+ */
+
+namespace Eighteen73\Orbit;
+
+/**
+ * This class is built upon BE Media from Production so all due credit to those authors.
+ * http://www.github.com/billerickson/be-media-from-production
+ */
+class BrandedEmails {
+
+	use Environment;
+	use Singleton;
+
+	/**
+	 * Primary constructor
+	 *
+	 * @return void
+	 */
+	public function setup() {
+		if ( apply_filters( 'orbit_branded_emails_disable', false ) ) {
+			return;
+		}
+
+		add_filter( 'wp_mail', [ $this, 'apply_branded_email_template' ] );
+		add_filter( 'gform_html_message_template_pre_send_email', [ $this, 'apply_branded_email_template_to_gf_notifications' ] );
+	}
+
+	/**
+	 * Wraps the original email message in a branded HTML email template.
+	 *
+	 * @param array $args Array of arguments passed to wp_mail().
+	 * @return array Modified $args array with the email message wrapped in branded HTML.
+	 */
+	public function apply_branded_email_template( $args ) {
+		$headers = [];
+
+		// Convert headers to an array if they aren't already
+		if ( empty( $args['headers'] ) ) {
+			$headers = [];
+		} elseif ( is_string( $args['headers'] ) ) {
+			$headers = explode( "\n", str_replace( "\r\n", "\n", $args['headers'] ) );
+		} elseif ( is_array( $args['headers'] ) ) {
+			$headers = $args['headers'];
+		}
+
+		// Check if Content-Type is already set to HTML
+		$content_type_is_html = false;
+		foreach ( $headers as $header ) {
+			if ( stripos( $header, 'Content-Type:' ) !== false && stripos( $header, 'text/html' ) !== false ) {
+				$content_type_is_html = true;
+				break;
+			}
+		}
+
+		// If email is already HTML return original $args
+		if ( $content_type_is_html ) {
+			return $args;
+		}
+
+		ob_start();
+
+		Templates::include_template_part(
+			'branded-emails/email-template.php',
+			[
+				'email_content' => $args['message'],
+				'email_subject' => isset( $args['subject'] ) ? $args['subject'] : '',
+			]
+		);
+
+		$styled_message = ob_get_clean();
+
+		// Remove existing Content-Type headers (at this point we've already established it's not HTML)
+		$headers = array_filter(
+			$headers,
+			function ( $header ) {
+				return stripos( $header, 'Content-Type:' ) === false;
+			}
+		);
+
+		// Add HTML Content-Type
+		$headers[] = 'Content-Type: text/html; charset=UTF-8';
+
+		// Set updated headers and message
+		$args['headers'] = $headers;
+		$args['message'] = $styled_message;
+
+		return $args;
+	}
+
+	/**
+	 * Provides a branded HTML template for Gravity Forms email notifications.
+	 *
+	 * `{message}` and `{subject}` placeholders will be replaced by
+	 * Gravity Forms with the actual notification content.
+	 *
+	 * @param string $template The original email template string (usually empty).
+	 * @return string The modified email template with placeholders for message and subject.
+	 */
+	public function apply_branded_email_template_to_gf_notifications( $template ) {
+		ob_start();
+
+		Templates::include_template_part(
+			'branded-emails/email-template.php',
+			[
+				'email_content' => '{message}',
+				'email_subject' => '{subject}',
+			]
+		);
+
+		$template = ob_get_clean();
+
+		return $template;
+	}
+}

includes/classes/Templates.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * Template functions for Orbit.
+ *
+ * @package         Orbit
+ */
+
+namespace Eighteen73\Orbit;
+
+/**
+ * This class is built upon BE Media from Production so all due credit to those authors.
+ * http://www.github.com/billerickson/be-media-from-production
+ */
+class Templates {
+
+	use Environment;
+	use Singleton;
+
+	/**
+	 * Function to get the template file from the theme if it exists, otherwise from the plugin.
+	 *
+	 * @param string $template_name The name of the template file.
+	 * @return string The path to the template file.
+	 */
+	private static function get_template_part( $template_name ) {
+		$theme_template = get_stylesheet_directory() . '/template-parts/' . $template_name;
+
+		if ( file_exists( $theme_template ) ) :
+			return $theme_template;
+		endif;
+
+		return ORBIT_PATH . 'template-parts/' . $template_name;
+	}
+
+	/**
+	 * Function to include the template file from the get_template_part function.
+	 *
+	 * @param string $template_name The name of the template file.
+	 * @param array  $args          Optional. Associative array of variables to make available in the template.
+	 */
+	public static function include_template_part( string $template_name, array $args = [] ) {
+
+		$template_path = self::get_template_part( $template_name );
+
+		if ( file_exists( $template_path ) ) {
+			include $template_path;
+		}
+	}
+}

orbit.php

@@ -45,6 +45,7 @@ function () {
 		Security\HideAuthor::instance()->setup();
 		Security\HideVersion::instance()->setup();
 		Security\RemoveHeadLinks::instance()->setup();
+		BrandedEmails::instance()->setup();
 		OtherFilters::instance()->setup();
 		HealthCheck::instance()->setup();
 		RemoteFiles::instance()->setup();

template-parts/branded-emails/email-styles.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * Branded Email Styles
+ * This file can be overridden in your theme.
+ *
+ * @package         Orbit
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+$background_color = apply_filters( 'orbit_branded_emails_background_color', '#f4f4f4' );
+$body_background_color = apply_filters( 'orbit_branded_emails_body_background_color', '#ffffff' );
+$body_border_color = apply_filters( 'orbit_branded_emails_body_border_color', '#ddd' );
+$body_max_width = apply_filters( 'orbit_branded_emails_body_max_width', '800px' );
+$body_text_color = apply_filters( 'orbit_branded_emails_body_text_color', '#000' );
+$footer_text_color = apply_filters( 'orbit_branded_emails_footer_text_color', '#999' );
+?>
+
+<style>
+	body {
+		background: <?php echo esc_attr( $background_color ); ?>;
+		font-family: "Helvetica Neue", Helvetica, Roboto, Arial, sans-serif;
+		padding: 20px;
+	}
+
+	.email-wrapper {
+		background: <?php echo esc_attr( $body_background_color ); ?>;
+		border: 1px solid <?php echo esc_attr( $body_border_color ); ?>;
+		border-radius: 6px;
+		color: <?php echo esc_attr( $body_text_color ); ?>;
+		max-width: <?php echo esc_attr( $body_max_width ); ?>;
+		margin: 0 auto;
+		padding: 20px;
+	}
+
+	.email-header img {
+		max-height: 100px;
+		width: auto;
+	}
+
+	.email-content {
+		margin-bottom: 40px;
+		margin-top: 40px;
+	}
+
+	.email-footer {
+		color: <?php echo esc_attr( $footer_text_color ); ?>;
+		font-size: 12px;
+		margin-top: 20px;
+		text-align: center;
+	}
+</style>

template-parts/branded-emails/email-template.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Branded Email Template
+ * This file can be overridden in your theme.
+ *
+ * @package         Orbit
+ *
+ * @var string $email_content
+ */
+
+namespace Eighteen73\Orbit;
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+$header_logo = apply_filters( 'orbit_branded_emails_header_logo', '' );
+$email_content = $args['email_content'] ?? '';
+$email_subject = $args['email_subject'] ?? get_bloginfo( 'name', 'display' );
+?>
+
+<!DOCTYPE html>
+<html>
+	<head>
+		<meta charset="UTF-8">
+		<title><?php echo esc_attr( $email_subject ); ?></title>
+		<?php Templates::include_template_part( 'branded-emails/email-styles.php' ); ?>
+	</head>
+
+	<body>
+		<div class="email-wrapper">
+			<div class="email-header">
+				<?php
+				if ( ! empty( $header_logo ) ) {
+					echo '<p style="margin-top:0;"><img src="' . esc_url( $header_logo ) . '" alt="' . esc_attr( get_bloginfo( 'name', 'display' ) ) . '" /></p>';
+				} else {
+					echo '<h1>' . esc_html( get_bloginfo( 'name' ) ) . '</h1>';
+				}
+				?>
+			</div>
+
+			<div class="email-content">
+				<?php echo wp_kses_post( wpautop( $email_content ) ); ?>
+			</div>
+
+			<div class="email-footer">
+				Sent from <?php echo esc_html( get_bloginfo( 'name', 'display' ) ); ?>
+			</div>
+		</div>
+	</body>
+</html>