Changeset 47574

Timestamp:

04/13/2020 03:29:17 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Plugins: Simplify the logic of validate_plugin_requirements(), update documentation.

This updates the function for consistency with validate_theme_requirements().

Follow-up to [44978], [45546], [47573].

Fixes #43992.

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (3 diffs)

trunk/src/wp-admin/includes/plugin.php

@@ -1101 +1101 @@
 
 /**
- * Validate the plugin requirements for WP version and PHP version.
+ * Validates the plugin requirements for WordPress version and PHP version.
+ *
+ * Uses the information from `Requires at least` and `Requires PHP` headers
+ * defined in the plugin's main PHP file.
+ *
+ * If the headers are not present in the plugin's main PHP file,
+ * `readme.txt` is also checked as a fallback.
  *
  * @since 5.2.0
+ * @since 5.3.0 Added support for reading the headers from the plugin's
+ *              main PHP file, with `readme.txt` as a fallback.
  *
  * @param string $plugin Path to the plugin file relative to the plugins directory.
@@ -1109 +1117 @@
  */
 function validate_plugin_requirements( $plugin ) {
+        $plugin_headers = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );
+
+        $requirements = array(
+                'requires'     => ! empty( $plugin_headers['RequiresWP'] ) ? $plugin_headers['RequiresWP'] : '',
+                'requires_php' => ! empty( $plugin_headers['RequiresPHP'] ) ? $plugin_headers['RequiresPHP'] : '',
+        );
+
         $readme_file = WP_PLUGIN_DIR . '/' . dirname( $plugin ) . '/readme.txt';
-        $plugin_data = array(
-                'requires'     => '',
-                'requires_php' => '',
-        );
 
         if ( file_exists( $readme_file ) ) {
-                $plugin_data = get_file_data(
+                $readme_headers = get_file_data(
                         $readme_file,
                         array(
@@ -1124 +1135 @@
                         'plugin'
                 );
-        }
-
-        $plugin_data = array_merge( $plugin_data, get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin ) );
-
-        // Check for headers in the plugin's PHP file, give precedence to the plugin headers.
-        $plugin_data['requires']     = ! empty( $plugin_data['RequiresWP'] ) ? $plugin_data['RequiresWP'] : $plugin_data['requires'];
-        $plugin_data['requires_php'] = ! empty( $plugin_data['RequiresPHP'] ) ? $plugin_data['RequiresPHP'] : $plugin_data['requires_php'];
-
-        $plugin_data['wp_compatible']  = is_wp_version_compatible( $plugin_data['requires'] );
-        $plugin_data['php_compatible'] = is_php_version_compatible( $plugin_data['requires_php'] );
-
-        if ( ! $plugin_data['wp_compatible'] && ! $plugin_data['php_compatible'] ) {
+
+                $requirements = array_merge( $readme_headers, $requirements );
+        }
+
+        $compatible_wp  = is_wp_version_compatible( $requirements['requires'] );
+        $compatible_php = is_php_version_compatible( $requirements['requires_php'] );
+
+        if ( ! $compatible_wp && ! $compatible_php ) {
                 return new WP_Error(
                         'plugin_wp_php_incompatible',
                         sprintf(
                                 /* translators: %s: Plugin name. */
-                                __( '<strong>Error:</strong> Current WordPress and PHP versions do not meet minimum requirements for %s.' ),
-                                $plugin_data['Name']
+                                _x( '<strong>Error:</strong> Current WordPress and PHP versions do not meet minimum requirements for %s.', 'plugin' ),
+                                $plugin_headers['Name']
                         )
                 );
-        } elseif ( ! $plugin_data['php_compatible'] ) {
+        } elseif ( ! $compatible_php ) {
                 return new WP_Error(
                         'plugin_php_incompatible',
                         sprintf(
                                 /* translators: %s: Plugin name. */
-                                __( '<strong>Error:</strong> Current PHP version does not meet minimum requirements for %s.' ),
-                                $plugin_data['Name']
+                                _x( '<strong>Error:</strong> Current PHP version does not meet minimum requirements for %s.', 'plugin' ),
+                                $plugin_headers['Name']
                         )
                 );
-        } elseif ( ! $plugin_data['wp_compatible'] ) {
+        } elseif ( ! $compatible_wp ) {
                 return new WP_Error(
                         'plugin_wp_incompatible',
                         sprintf(
                                 /* translators: %s: Plugin name. */
-                                __( '<strong>Error:</strong> Current WordPress version does not meet minimum requirements for %s.' ),
-                                $plugin_data['Name']
+                                _x( '<strong>Error:</strong> Current WordPress version does not meet minimum requirements for %s.', 'plugin' ),
+                                $plugin_headers['Name']
                         )
                 );