Update rrze-legal.php

Author: rvdforst

rrze-legal.php

@@ -3,15 +3,15 @@
 /*
 Plugin Name:        RRZE Legal
 Plugin URI:         https://gitlab.rrze.fau.de/rrze-webteam/rrze-legal
-Version:            2.7.8
+Version:            2.7.9
 Description:        Legal Mandatory Information & GDPR.
 Author:             RRZE Webteam
 Author URI:         https://www.rrze.fau.de
 License:            GNU General Public License Version 3
 License URI:        https://www.gnu.org/licenses/gpl-3.0.html
 Text Domain:        rrze-legal
 Domain Path:        /languages
-Requires at least:  6.6
+Requires at least:  6.7
 Requires PHP:       8.2
 */
 
@@ -25,9 +25,6 @@
 use RRZE\Legal\Consent\Categories\Options as ConsentCategoriesOptions;
 use RRZE\Legal\Consent\Cookies\Options as ConsentCookiesOptions;
 
-const RRZE_PHP_VERSION = '8.2';
-const RRZE_WP_VERSION  = '6.6';
-
 /**
  * SPL Autoloader (PSR-4).
  * @param string $class The fully-qualified class name.
@@ -50,60 +47,38 @@
     }
 });
 
-// Register plugin hooks.
-register_activation_hook(__FILE__, __NAMESPACE__ . '\activation');
-register_deactivation_hook(__FILE__, __NAMESPACE__ . '\deactivation');
+// Load the plugin's text domain for localization.
+add_action('init', fn() => load_plugin_textdomain('rrze-legal', false, dirname(plugin_basename(__FILE__)) . '/languages'));
 
-add_action('plugins_loaded', __NAMESPACE__ . '\loaded');
 
-/**
- * Loads a plugin’s translated strings.
- */
-function loadTextdomain()
-{
-    load_plugin_textdomain('rrze-legal', false, dirname(plugin_basename(__FILE__)) . '/languages');
-}
+// Register activation hook for the plugin
+register_activation_hook(__FILE__, __NAMESPACE__ . '\activation');
+
+// Register deactivation hook for the plugin
+register_deactivation_hook(__FILE__, __NAMESPACE__ . '\deactivation');
 
 /**
- * System requirements verification.
- * @return string Return an error message.
+ * Add an action hook for the 'plugins_loaded' hook.
+ *
+ * This code hooks into the 'plugins_loaded' action hook to execute a callback function when
+ * WordPress has fully loaded all active plugins and the theme's functions.php file.
  */
-function systemRequirements(): string
-{
-    $error = '';
-    if (version_compare(PHP_VERSION, RRZE_PHP_VERSION, '<')) {
-        $error = sprintf(
-            /* translators: 1: Server PHP version number, 2: Required PHP version number. */
-            __('The server is running PHP version %1$s. The Plugin requires at least PHP version %2$s.', 'rrze-legal'),
-            PHP_VERSION,
-            RRZE_PHP_VERSION
-        );
-    } elseif (version_compare($GLOBALS['wp_version'], RRZE_WP_VERSION, '<')) {
-        $error = sprintf(
-            /* translators: 1: Server WordPress version number, 2: Required WordPress version number. */
-            __('The server is running WordPress version %1$s. The Plugin requires at least WordPress version %2$s.', 'rrze-legal'),
-            $GLOBALS['wp_version'],
-            RRZE_WP_VERSION
-        );
-    }
-    return $error;
-}
+add_action('plugins_loaded', __NAMESPACE__ . '\loaded');
 
 /**
  * Activation callback function.
  */
 function activation()
 {
-    loadTextdomain();
     if ($error = systemRequirements()) {
         deactivate_plugins(plugin_basename(__FILE__));
         wp_die(
-            esc_html(sprintf(
+            sprintf(
                 /* translators: 1: The plugin name, 2: The error string. */
                 __('Plugins: %1$s: %2$s', 'rrze-legal'),
                 plugin_basename(__FILE__),
                 $error
-            ), 'post')
+            )
         );
     }
 }
@@ -232,35 +207,89 @@ function fauDomains(): array
 }
 
 /**
- * Execute on 'plugins_loaded' API/action.
- * @return void
+ * Check system requirements for the plugin.
+ *
+ * This method checks if the server environment meets the minimum WordPress and PHP version requirements
+ * for the plugin to function properly.
+ *
+ * @return string An error message string if requirements are not met, or an empty string if requirements are satisfied.
+ */
+function systemRequirements(): string
+{
+    // Get the global WordPress version.
+    global $wp_version;
+
+    // Get the PHP version.
+    $phpVersion = phpversion();
+
+    // Initialize an error message string.
+    $error = '';
+
+    // Check if the WordPress version is compatible with the plugin's requirement.
+    if (!is_wp_version_compatible(plugin()->getRequiresWP())) {
+        $error = sprintf(
+            /* translators: 1: Server WordPress version number, 2: Required WordPress version number. */
+            __('The server is running WordPress version %1$s. The plugin requires at least WordPress version %2$s.', 'rrze-legal'),
+            $wp_version,
+            plugin()->getRequiresWP()
+        );
+    } elseif (!is_php_version_compatible(plugin()->getRequiresPHP())) {
+        // Check if the PHP version is compatible with the plugin's requirement.
+        $error = sprintf(
+            /* translators: 1: Server PHP version number, 2: Required PHP version number. */
+            __('The server is running PHP version %1$s. The plugin requires at least PHP version %2$s.', 'rrze-legal'),
+            $phpVersion,
+            plugin()->getRequiresPHP()
+        );
+    }
+
+    // Return the error message string, which will be empty if requirements are satisfied.
+    return $error;
+}
+
+/**
+ * Handle the loading of the plugin.
+ *
+ * This function is responsible for initializing the plugin, loading text domains for localization,
+ * checking system requirements, and displaying error notices if necessary.
  */
 function loaded()
 {
     if (!tosPluginDeactivation()) {
         return;
     }
-    loadTextdomain();
+    // Trigger the 'loaded' method of the main plugin instance.
     plugin()->loaded();
+    // Check system requirements and store any error messages.
     if ($error = systemRequirements()) {
+        // If there is an error, add an action to display an admin notice with the error message.
         add_action('admin_init', function () use ($error) {
+            // Check if the current user has the capability to activate plugins.
             if (current_user_can('activate_plugins')) {
-                $pluginData = get_plugin_data(plugin()->getFile());
-                $pluginName = $pluginData['Name'];
+                // Get plugin data to retrieve the plugin's name.
+                $pluginName = plugin()->getName();
+
+                // Determine the admin notice tag based on network-wide activation.
                 $tag = is_plugin_active_for_network(plugin()->getBaseName()) ? 'network_admin_notices' : 'admin_notices';
+
+                // Add an action to display the admin notice.
                 add_action($tag, function () use ($pluginName, $error) {
                     printf(
                         '<div class="notice notice-error"><p>' .
                             /* translators: 1: The plugin name, 2: The error string. */
-                            esc_html(__('Plugins: %1$s: %2$s', 'rrze-legal'), 'post') .
+                            esc_html__('Plugins: %1$s: %2$s', 'rrze-legal') .
                             '</p></div>',
-                        esc_html($pluginName),
-                        esc_html($error)
+                        $pluginName,
+                        $error
                     );
                 });
             }
         });
+
+        // Return to prevent further initialization if there is an error.
         return;
     }
+
+    // If there are no errors, create an instance of the 'Main' class
     new Main;
 }