Another fixes

Author: oleksandr-mykhailenko

includes/admin.php

@@ -1,6 +1,5 @@
 <?php
-
-/*
+/**
  * mailgun-wordpress-plugin - Sending mail from WordPress using Mailgun
  * Copyright (C) 2016 Mailgun, et al.
  *
@@ -17,8 +16,9 @@
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * @package Mailgun
  */
-
 class MailgunAdmin extends Mailgun {
 
     /**
@@ -31,6 +31,9 @@ class MailgunAdmin extends Mailgun {
      */
     protected array $options = array();
 
+    /**
+     * @var string $hook_suffix
+     */
     protected $hook_suffix;
 
     /**
@@ -400,11 +403,10 @@ public function filter_plugin_actions( array $links ): array {
     /**
      * AJAX callback function to test mail sending functionality.
      *
-     * @return    string
-     *
+     * @return void
      * @throws JsonException
      */
-    public function ajax_send_test(): string {
+    public function ajax_send_test(): void {
         nocache_headers();
         header('Content-Type: application/json');
 

includes/mg-filter.php

@@ -1,6 +1,5 @@
 <?php
-
-/*
+/**
  * mailgun-wordpress-plugin - Sending mail from Wordpress using Mailgun
  * Copyright (C) 2016 Mailgun, et al.
  *
@@ -17,9 +16,10 @@
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * @package Mailgun
  */
 
-
 /**
  * Tries several methods to get the MIME Content-Type of a file.
  *
@@ -60,6 +60,7 @@ function get_mime_content_type( string $filepath, string $default_type = 'text/p
  * `$from_addr` before being returned. The filtered result is null-tested
  * before being returned.
  *
+ * @param string $from_name_header
  * @return    string
  *
  * @since    1.5.8
@@ -108,7 +109,7 @@ function mg_detect_from_name( $from_name_header = null ): string {
  * This operates as a filter for the from address. If the override is set,
  * a given address will except in ONE case.
  * If the override is not enabled this is the from address resolution order:
- *  1. From address given by headers - {@param $from_addr_header}
+ *  1. From address given by headers - {$from_addr_header}
  *  2. From address set in Mailgun settings
  *  3. From `MAILGUN_FROM_ADDRESS` constant
  *  4. From address constructed as `wordpress@<your_site_domain>`
@@ -123,8 +124,7 @@ function mg_detect_from_name( $from_name_header = null ): string {
  * might appear to be another option but some hosts may refuse to
  * relay mail from an unknown domain.
  *
- * @link     http://trac.wordpress.org/ticket/5007.
- *
+ * @param null $from_addr_header
  * @return    string
  *
  * @since    1.5.8

includes/options-page.php

@@ -1,6 +1,5 @@
 <?php
-
-/*
+/**
  * mailgun-wordpress-plugin - Sending mail from Wordpress using Mailgun
  * Copyright (C) 2016 Mailgun, et al.
  *
@@ -17,6 +16,8 @@
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * @package Mailgun
  */
 
 $mailgun = Mailgun::getInstance();

includes/widget.php

@@ -1,7 +1,7 @@
 <?php
-
-/*
- * mailgun-wordpress-plugin - Sending mail from Wordpress using Mailgun
+/**
+ * @file wp-content/plugins/wordpress-plugin/includes/widget.php
+ * Mailgun-wordpress-plugin - Sending mail from Wordpress using Mailgun
  * Copyright (C) 2016 Mailgun, et al.
  *
  * This program is free software; you can redistribute it and/or modify
@@ -17,10 +17,14 @@
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * @package Mailgun
  */
+class List_Widget extends \WP_Widget {
 
-class list_widget extends \WP_Widget {
-
+    /**
+     * Register widget with WordPress.
+     */
     public function __construct() {
         parent::__construct(
             // Base ID of your widget
@@ -33,8 +37,8 @@ public function __construct() {
     }
 
     /**
-     * @param $args
-     * @param $instance
+     * @param mixed $args
+     * @param mixed $instance
      * @return void
      * @throws JsonException
      */
@@ -65,7 +69,7 @@ public function widget( $args, $instance ) {
     // Widget Backend
 
     /**
-     * @param $instance
+     * @param mixed $instance
      * @return string|void
      */
     public function form( $instance ) {
@@ -107,11 +111,9 @@ public function form( $instance ) {
         <?php
     }
 
-    // Updating widget replacing old instances with new
-
     /**
-     * @param $new_instance
-     * @param $old_instance
+     * @param mixed $new_instance
+     * @param mixed $old_instance
      * @return array
      */
     public function update( $new_instance, $old_instance ) {

mailgun.php

@@ -514,7 +514,7 @@ public function build_list_form( array $atts ): string {
      * Initialize List Widget.
      */
     public function load_list_widget() {
-        register_widget( 'list_widget' );
+        register_widget( 'List_Widget' );
         add_shortcode( 'mailgun', array( &$this, 'build_list_form' ) );
     }
 

phpcs.xml.dist

@@ -104,5 +104,8 @@
         <exclude name="Generic.CodeAnalysis.AssignmentInCondition.Found"/>
         <exclude name="Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure"/>
         <exclude name="Generic.WhiteSpace.ArbitraryParenthesesSpacing.SpaceBeforeClose"/>
+        <exclude name="WordPress.PHP.DontExtract.extract_extract"/>
+        <exclude name="Squiz.Commenting.FileComment.Missing"/>
+        <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCatch"/>
     </rule>
 </ruleset>