Admin notice improvements. (#174)

Small code cleanup
mailgun · Feb 25, 2024 · 77dcd63 · 77dcd63
1 parent 41b8d45
commit 77dcd63
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 62 deletions.
diff --git a/includes/admin.php b/includes/admin.php
@@ -61,17 +61,16 @@ public function __construct()
         add_action('wp_ajax_mailgun-test', [&$this, 'ajax_send_test']);
     }
 
-	/**
-	 * Adds the default options during plugin activation.
-	 *
-	 * @return    void
-	 *
-	 */
-	public function activation() {
-		if (!$this->options) {
-			$this->options = $this->defaults;
-			add_option('mailgun', $this->options);
-		}
+    /**
+     * Adds the default options during plugin activation.
+     * @return    void
+     */
+    public function activation(): void
+    {
+        if (!$this->options) {
+            $this->options = $this->defaults;
+            add_option('mailgun', $this->options);
+        }
     }
 
 
@@ -81,7 +80,7 @@ public function activation() {
      * @return    void
      *
      */
-    public function init()
+    public function init(): void
     {
         $sitename = sanitize_text_field(strtolower($_SERVER['SERVER_NAME']));
         if (substr($sitename, 0, 4) === 'www.') {
@@ -338,26 +337,25 @@ public function admin_notices(): void
         $apiKeyUndefined = (!$this->get_option('apiKey') && (!defined('MAILGUN_APIKEY') || !MAILGUN_APIKEY));
         $apiActiveNotConfigured = ($this->get_option('useAPI') === '1' && ($apiRegionUndefined || $apiKeyUndefined));
 
-        if ($apiActiveNotConfigured || $smtpActiveNotConfigured):
-            ?>
+        if ($_SESSION['settings_turned_of'] === false && ($apiActiveNotConfigured || $smtpActiveNotConfigured) ) { ?>
             <div id='mailgun-warning' class='notice notice-warning is-dismissible'>
                 <p>
                     <?php
                     printf(
-                        __('Mailgun now supports multiple regions! The U.S. region will be used by default, but you can choose the EU region. You can configure your Mailgun settings in your wp-config.php file or <a href="%1$s">here</a>',
+                        __('Use HTTP API is turned off or you do not have SMTP credentials. You can configure your Mailgun settings in your wp-config.php file or <a href="%1$s">here</a>',
                             'mailgun'),
                         menu_page_url('mailgun', false)
                     );
                     ?>
                 </p>
             </div>
-        <?php
-        endif;
+        <?php $_SESSION['settings_turned_of'] = true; ?>
+        <?php } ?>
 
+        <?php
         if ($this->get_option('override-from') === '1' &&
             (!$this->get_option('from-name') || !$this->get_option('from-address'))
-        ):
-            ?>
+        ) { ?>
             <div id='mailgun-warning' class='notice notice-warning is-dismissible'>
                 <p>
                     <strong>
@@ -372,8 +370,7 @@ public function admin_notices(): void
                     ?>
                 </p>
             </div>
-        <?php
-        endif;
+        <?php }
     }
 
     /**
@@ -384,7 +381,7 @@ public function admin_notices(): void
      * @return    array
      *
      */
-    public function filter_plugin_actions($links): array
+    public function filter_plugin_actions(array $links): array
     {
         $settings_link = '<a href="' . menu_page_url('mailgun', false) . '">' . __('Settings', 'mailgun') . '</a>';
         array_unshift($links, $settings_link);
@@ -462,9 +459,6 @@ public function ajax_send_test()
             //Log purpose
         }
 
-
-
-
         if ($useAPI) {
             if (!function_exists('mg_api_last_error')) {
                 if (!include __DIR__ . '/wp-mail-api.php') {

diff --git a/includes/lists-page.php b/includes/lists-page.php
@@ -26,8 +26,8 @@
 $api_key = (defined('MAILGUN_APIKEY') && MAILGUN_APIKEY) ? MAILGUN_APIKEY : $this->get_option('apiKey');
 $mailgun_domain = (defined('MAILGUN_DOMAIN') && MAILGUN_DOMAIN) ? MAILGUN_DOMAIN : $this->get_option('domain');
 
-if ($api_key != '') {
-    if ($mailgun_domain == '') {
+if ($api_key !== '') {
+    if ($mailgun_domain === '') {
         $missing_error = '<strong style="color:red;">Missing or invalid Mailgun Domain</strong>. ';
     }
 } else {

diff --git a/includes/mg-filter.php b/includes/mg-filter.php
@@ -80,21 +80,19 @@ function mg_detect_from_name($from_name_header = null)
         $from_name = $from_name_header;
     } elseif (defined('MAILGUN_FROM_NAME') && MAILGUN_FROM_NAME) {
         $from_name = MAILGUN_FROM_NAME;
-    } else {
-        if (empty($mg_from_name)) {
-            if (function_exists('get_current_site')) {
-                $from_name = get_current_site()->site_name;
-            } else {
-                $from_name = 'WordPress';
-            }
+    } else if (empty($mg_from_name)) {
+        if (function_exists('get_current_site')) {
+            $from_name = get_current_site()->site_name;
         } else {
-            $from_name = $mg_from_name;
+            $from_name = 'WordPress';
         }
+    } else {
+        $from_name = $mg_from_name;
     }
 
     $filter_from_name = null;
 
-    if ((!isset($mg_override_from) || $mg_override_from == '0') && has_filter('wp_mail_from_name')) {
+    if ((!isset($mg_override_from) || $mg_override_from === '0') && has_filter('wp_mail_from_name')) {
         $filter_from_name = apply_filters(
             'wp_mail_from_name',
             $from_name
@@ -148,25 +146,23 @@ function mg_detect_from_address($from_addr_header = null): string
         $from_addr = $from_addr_header;
     } elseif (defined('MAILGUN_FROM_ADDRESS') && MAILGUN_FROM_ADDRESS) {
         $from_addr = MAILGUN_FROM_ADDRESS;
-    } else {
-        if (empty($mg_from_addr)) {
-            if (function_exists('get_current_site')) {
-                $sitedomain = get_current_site()->domain;
-            } else {
-                $sitedomain = strtolower(sanitize_text_field($_SERVER['SERVER_NAME']));
-                if (substr($sitedomain, 0, 4) === 'www.') {
-                    $sitedomain = substr($sitedomain, 4);
-                }
-            }
-
-            $from_addr = 'wordpress@' . $sitedomain;
+    } else if (empty($mg_from_addr)) {
+        if (function_exists('get_current_site')) {
+            $sitedomain = get_current_site()->domain;
         } else {
-            $from_addr = $mg_from_addr;
+            $sitedomain = strtolower(sanitize_text_field($_SERVER['SERVER_NAME']));
+            if (substr($sitedomain, 0, 4) === 'www.') {
+                $sitedomain = substr($sitedomain, 4);
+            }
         }
+
+        $from_addr = 'wordpress@' . $sitedomain;
+    } else {
+        $from_addr = $mg_from_addr;
     }
 
     $filter_from_addr = null;
-    if ((!isset($mg_override_from) || $mg_override_from == '0') && has_filter('wp_mail_from')) {
+    if ((!isset($mg_override_from) || $mg_override_from === '0') && has_filter('wp_mail_from')) {
         $filter_from_addr = apply_filters(
             'wp_mail_from',
             $from_addr
@@ -214,7 +210,7 @@ function mg_parse_headers($headers = []): array
         $tmp = $headers;
     }
 
-    $new_headers = array();
+    $new_headers = [];
     if (!empty($tmp)) {
         $name = null;
         $value = null;
@@ -242,14 +238,14 @@ function mg_parse_headers($headers = []): array
             $value = trim($value);
 
             if (!isset($new_headers[$name])) {
-                $new_headers[$name] = array();
+                $new_headers[$name] = [];
             }
 
-            $new_headers[$name][] = array(
+            $new_headers[$name][] = [
                 'value' => $value,
                 'boundary' => $boundary,
                 'parts' => $parts,
-            );
+            ];
         }
     }
 
@@ -268,7 +264,7 @@ function mg_parse_headers($headers = []): array
  */
 function mg_dump_headers($headers = null): string
 {
-    if (is_null($headers) || !is_array($headers)) {
+    if (!is_array($headers)) {
         return '';
     }
 

diff --git a/includes/options-page.php b/includes/options-page.php
@@ -56,10 +56,10 @@
 <div class="wrap">
     <div id="icon-options-general" class="icon32"><br/></div>
     <span class="alignright">
-				<a target="_blank" href="http://www.mailgun.com/">
-					<img src="<?php echo esc_attr($icon) ?>" alt="Mailgun" style="width:50px;"/>
-				</a>
-			</span>
+            <a target="_blank" href="http://www.mailgun.com/">
+                <img src="<?php echo esc_attr($icon) ?>" alt="Mailgun" style="width:50px;"/>
+            </a>
+    </span>
     <h2><?php _e('Mailgun', 'mailgun'); ?></h2>
 
     <p>

diff --git a/includes/wp-mail-api.php b/includes/wp-mail-api.php
@@ -58,9 +58,11 @@ function mg_api_last_error(string $error = null): ?string
  * @since 1.5.7
  */
 add_filter('mg_mutate_to_rcpt_vars', 'mg_mutate_to_rcpt_vars_cb');
+
 /**
  * @param $to_addrs
  * @return array
+ * @throws JsonException
  */
 function mg_mutate_to_rcpt_vars_cb($to_addrs): array
 {

diff --git a/mailgun.php b/mailgun.php
@@ -3,7 +3,7 @@
  * Plugin Name:  Mailgun
  * Plugin URI:   http://wordpress.org/extend/plugins/mailgun/
  * Description:  Mailgun integration for WordPress
- * Version:      1.9.7
+ * Version:      1.9.8
  * Requires PHP: 7.4
  * Requires at least: 4.4
  * Author:       Mailgun

diff --git a/readme.md b/readme.md
@@ -4,7 +4,7 @@ Mailgun for WordPress
 Contributors: mailgun, sivel, lookahead.io, m35dev, alanfuller
 Tags: mailgun, smtp, http, api, mail, email
 Tested up to: 6.4
-Stable tag: 1.9.7
+Stable tag: 1.9.8
 License: GPLv2 or later
 
 Easily send email from your WordPress site through Mailgun using the HTTP API or SMTP.
@@ -130,6 +130,10 @@ MAILGUN_TRACK_OPENS  Type: string Choices: 'yes' or 'no'
 
 
 == Changelog ==
+= 1.9.8 (2024-02-25): =
+ - Improve admin notices about not fully configured plugin
+ - Small code cleaning
+
 = 1.9.7 (2024-01-03): =
 - Ensure defaults are always set to remove warnings in PHP 8.1+
 

diff --git a/readme.txt b/readme.txt
@@ -4,7 +4,7 @@ Mailgun for WordPress
 Contributors: mailgun, sivel, lookahead.io, m35dev, alanfuller
 Tags: mailgun, smtp, http, api, mail, email
 Tested up to: 6.4
-Stable tag: 1.9.7
+Stable tag: 1.9.8
 License: GPLv2 or later
 
 Easily send email from your WordPress site through Mailgun using the HTTP API or SMTP.
@@ -128,6 +128,10 @@ MAILGUN_TRACK_OPENS  Type: string Choices: 'yes' or 'no'
 
 
 == Changelog ==
+= 1.9.8 (2024-02-25): =
+ - Improve admin notices about not fully configured plugin
+ - Small code cleaning
+
 = 1.9.7 (2024-01-03): =
 - Ensure defaults are always set to remove warnings in PHP 8.1+