Changeset 59172

Timestamp:

10/04/2024 10:10:46 PM (2 months ago)

Author:

dmsnell

Message:

WP_Debug_Data: Extract wp-plugins data into separate methods.

This is the eighth part in a larger modularization of the data in WP_Debug_Data. Previously this was a single massive method drawing in debug data from various groups of related data, where the groups were independent from each other.

This patch separates the eighth and ninth of twelve groups, the wp-plugins-active and wp-plugins-inactive info, into separate methods focused on that data.

Unlike the other patches in this series, the plugins data comes from a single source and is separated out into separate debug sections, so the active and inactive methods call a new shared method which provides raw data for both. Optimizations and refactors may occur in follow-up tickets.

This work precedes changes to make the WP_Debug_Data class more extensible for better use by plugin and theme code.

Developed in ​https://github.com/wordpress/wordpress-develop/pull/7458
Discussed in https://core.trac.wordpress.org/ticket/61648

Props apermo, dmsnell.
See #61648.

File:

• trunk/src/wp-admin/includes/class-wp-debug-data.php (modified) (4 diffs)

trunk/src/wp-admin/includes/class-wp-debug-data.php

@@ -83 +83 @@
             'wp-themes-inactive'  => array(),
             'wp-mu-plugins'       => self::get_wp_mu_plugins(),
-            'wp-plugins-active'   => array(),
-            'wp-plugins-inactive' => array(),
+            'wp-plugins-active'   => self::get_wp_plugins_active(),
+            'wp-plugins-inactive' => self::get_wp_plugins_inactive(),
             'wp-media'            => self::get_wp_media(),
             'wp-server'           => self::get_wp_server(),
@@ -185 +185 @@
         $info['wp-themes-inactive'] = array(
             'label'      => __( 'Inactive Themes' ),
-            'show_count' => true,
-            'fields'     => array(),
-        );
-
-        $info['wp-plugins-active'] = array(
-            'label'      => __( 'Active Plugins' ),
-            'show_count' => true,
-            'fields'     => array(),
-        );
-
-        $info['wp-plugins-inactive'] = array(
-            'label'      => __( 'Inactive Plugins' ),
             'show_count' => true,
             'fields'     => array(),
@@ -323 +311 @@
                     'debug' => 'loading...',
                 ),
-            );
-        }
-
-        // List all available plugins.
-        $plugins        = get_plugins();
-        $plugin_updates = get_plugin_updates();
-        $transient      = get_site_transient( 'update_plugins' );
-
-        $auto_updates = array();
-
-        $auto_updates_enabled = wp_is_auto_update_enabled_for_type( 'plugin' );
-
-        if ( $auto_updates_enabled ) {
-            $auto_updates = (array) get_site_option( 'auto_update_plugins', array() );
-        }
-
-        foreach ( $plugins as $plugin_path => $plugin ) {
-            $plugin_part = ( is_plugin_active( $plugin_path ) ) ? 'wp-plugins-active' : 'wp-plugins-inactive';
-
-            $plugin_version = $plugin['Version'];
-            $plugin_author  = $plugin['Author'];
-
-            $plugin_version_string       = __( 'No version or author information is available.' );
-            $plugin_version_string_debug = 'author: (undefined), version: (undefined)';
-
-            if ( ! empty( $plugin_version ) && ! empty( $plugin_author ) ) {
-                /* translators: 1: Plugin version number. 2: Plugin author name. */
-                $plugin_version_string       = sprintf( __( 'Version %1$s by %2$s' ), $plugin_version, $plugin_author );
-                $plugin_version_string_debug = sprintf( 'version: %s, author: %s', $plugin_version, $plugin_author );
-            } else {
-                if ( ! empty( $plugin_author ) ) {
-                    /* translators: %s: Plugin author name. */
-                    $plugin_version_string       = sprintf( __( 'By %s' ), $plugin_author );
-                    $plugin_version_string_debug = sprintf( 'author: %s, version: (undefined)', $plugin_author );
-                }
-
-                if ( ! empty( $plugin_version ) ) {
-                    /* translators: %s: Plugin version number. */
-                    $plugin_version_string       = sprintf( __( 'Version %s' ), $plugin_version );
-                    $plugin_version_string_debug = sprintf( 'author: (undefined), version: %s', $plugin_version );
-                }
-            }
-
-            if ( array_key_exists( $plugin_path, $plugin_updates ) ) {
-                /* translators: %s: Latest plugin version number. */
-                $plugin_version_string       .= ' ' . sprintf( __( '(Latest version: %s)' ), $plugin_updates[ $plugin_path ]->update->new_version );
-                $plugin_version_string_debug .= sprintf( ' (latest version: %s)', $plugin_updates[ $plugin_path ]->update->new_version );
-            }
-
-            if ( $auto_updates_enabled ) {
-                if ( isset( $transient->response[ $plugin_path ] ) ) {
-                    $item = $transient->response[ $plugin_path ];
-                } elseif ( isset( $transient->no_update[ $plugin_path ] ) ) {
-                    $item = $transient->no_update[ $plugin_path ];
-                } else {
-                    $item = array(
-                        'id'            => $plugin_path,
-                        'slug'          => '',
-                        'plugin'        => $plugin_path,
-                        'new_version'   => '',
-                        'url'           => '',
-                        'package'       => '',
-                        'icons'         => array(),
-                        'banners'       => array(),
-                        'banners_rtl'   => array(),
-                        'tested'        => '',
-                        'requires_php'  => '',
-                        'compatibility' => new stdClass(),
-                    );
-                    $item = wp_parse_args( $plugin, $item );
-                }
-
-                $auto_update_forced = wp_is_auto_update_forced_for_item( 'plugin', null, (object) $item );
-
-                if ( ! is_null( $auto_update_forced ) ) {
-                    $enabled = $auto_update_forced;
-                } else {
-                    $enabled = in_array( $plugin_path, $auto_updates, true );
-                }
-
-                if ( $enabled ) {
-                    $auto_updates_string = __( 'Auto-updates enabled' );
-                } else {
-                    $auto_updates_string = __( 'Auto-updates disabled' );
-                }
-
-                /**
-                 * Filters the text string of the auto-updates setting for each plugin in the Site Health debug data.
-                 *
-                 * @since 5.5.0
-                 *
-                 * @param string $auto_updates_string The string output for the auto-updates column.
-                 * @param string $plugin_path         The path to the plugin file.
-                 * @param array  $plugin              An array of plugin data.
-                 * @param bool   $enabled             Whether auto-updates are enabled for this item.
-                 */
-                $auto_updates_string = apply_filters( 'plugin_auto_update_debug_string', $auto_updates_string, $plugin_path, $plugin, $enabled );
-
-                $plugin_version_string       .= ' | ' . $auto_updates_string;
-                $plugin_version_string_debug .= ', ' . $auto_updates_string;
-            }
-
-            $info[ $plugin_part ]['fields'][ sanitize_text_field( $plugin['Name'] ) ] = array(
-                'label' => $plugin['Name'],
-                'value' => $plugin_version_string,
-                'debug' => $plugin_version_string_debug,
             );
         }
@@ -1290 +1172 @@
 
     /**
+     * Gets the WordPress active plugins section of the debug data.
+     *
+     * @since 6.7.0
+     *
+     * @return array
+     */
+    private static function get_wp_plugins_active(): array {
+        return array(
+            'label'      => __( 'Active Plugins' ),
+            'show_count' => true,
+            'fields'     => self::get_wp_plugins_raw_data()['wp-plugins-active'],
+        );
+    }
+
+    /**
+     * Gets the WordPress inactive plugins section of the debug data.
+     *
+     * @since 6.7.0
+     *
+     * @return array
+     */
+    private static function get_wp_plugins_inactive(): array {
+        return array(
+            'label'      => __( 'Inactive Plugins' ),
+            'show_count' => true,
+            'fields'     => self::get_wp_plugins_raw_data()['wp-plugins-inactive'],
+        );
+    }
+
+    /**
+     * Gets the raw plugin data for the WordPress active and inactive sections of the debug data.
+     *
+     * @since 6.7.0
+     *
+     * @return array
+     */
+    private static function get_wp_plugins_raw_data(): array {
+        // List all available plugins.
+        $plugins        = get_plugins();
+        $plugin_updates = get_plugin_updates();
+        $transient      = get_site_transient( 'update_plugins' );
+
+        $auto_updates = array();
+        $fields       = array(
+            'wp-plugins-active'   => array(),
+            'wp-plugins-inactive' => array(),
+        );
+
+        $auto_updates_enabled = wp_is_auto_update_enabled_for_type( 'plugin' );
+
+        if ( $auto_updates_enabled ) {
+            $auto_updates = (array) get_site_option( 'auto_update_plugins', array() );
+        }
+
+        foreach ( $plugins as $plugin_path => $plugin ) {
+            $plugin_part = ( is_plugin_active( $plugin_path ) ) ? 'wp-plugins-active' : 'wp-plugins-inactive';
+
+            $plugin_version = $plugin['Version'];
+            $plugin_author  = $plugin['Author'];
+
+            $plugin_version_string       = __( 'No version or author information is available.' );
+            $plugin_version_string_debug = 'author: (undefined), version: (undefined)';
+
+            if ( ! empty( $plugin_version ) && ! empty( $plugin_author ) ) {
+                /* translators: 1: Plugin version number. 2: Plugin author name. */
+                $plugin_version_string       = sprintf( __( 'Version %1$s by %2$s' ), $plugin_version, $plugin_author );
+                $plugin_version_string_debug = sprintf( 'version: %s, author: %s', $plugin_version, $plugin_author );
+            } else {
+                if ( ! empty( $plugin_author ) ) {
+                    /* translators: %s: Plugin author name. */
+                    $plugin_version_string       = sprintf( __( 'By %s' ), $plugin_author );
+                    $plugin_version_string_debug = sprintf( 'author: %s, version: (undefined)', $plugin_author );
+                }
+
+                if ( ! empty( $plugin_version ) ) {
+                    /* translators: %s: Plugin version number. */
+                    $plugin_version_string       = sprintf( __( 'Version %s' ), $plugin_version );
+                    $plugin_version_string_debug = sprintf( 'author: (undefined), version: %s', $plugin_version );
+                }
+            }
+
+            if ( array_key_exists( $plugin_path, $plugin_updates ) ) {
+                /* translators: %s: Latest plugin version number. */
+                $plugin_version_string       .= ' ' . sprintf( __( '(Latest version: %s)' ), $plugin_updates[ $plugin_path ]->update->new_version );
+                $plugin_version_string_debug .= sprintf( ' (latest version: %s)', $plugin_updates[ $plugin_path ]->update->new_version );
+            }
+
+            if ( $auto_updates_enabled ) {
+                if ( isset( $transient->response[ $plugin_path ] ) ) {
+                    $item = $transient->response[ $plugin_path ];
+                } elseif ( isset( $transient->no_update[ $plugin_path ] ) ) {
+                    $item = $transient->no_update[ $plugin_path ];
+                } else {
+                    $item = array(
+                        'id'            => $plugin_path,
+                        'slug'          => '',
+                        'plugin'        => $plugin_path,
+                        'new_version'   => '',
+                        'url'           => '',
+                        'package'       => '',
+                        'icons'         => array(),
+                        'banners'       => array(),
+                        'banners_rtl'   => array(),
+                        'tested'        => '',
+                        'requires_php'  => '',
+                        'compatibility' => new stdClass(),
+                    );
+                    $item = wp_parse_args( $plugin, $item );
+                }
+
+                $auto_update_forced = wp_is_auto_update_forced_for_item( 'plugin', null, (object) $item );
+
+                if ( ! is_null( $auto_update_forced ) ) {
+                    $enabled = $auto_update_forced;
+                } else {
+                    $enabled = in_array( $plugin_path, $auto_updates, true );
+                }
+
+                if ( $enabled ) {
+                    $auto_updates_string = __( 'Auto-updates enabled' );
+                } else {
+                    $auto_updates_string = __( 'Auto-updates disabled' );
+                }
+
+                /**
+                 * Filters the text string of the auto-updates setting for each plugin in the Site Health debug data.
+                 *
+                 * @since 5.5.0
+                 *
+                 * @param string $auto_updates_string The string output for the auto-updates column.
+                 * @param string $plugin_path         The path to the plugin file.
+                 * @param array  $plugin              An array of plugin data.
+                 * @param bool   $enabled             Whether auto-updates are enabled for this item.
+                 */
+                $auto_updates_string = apply_filters( 'plugin_auto_update_debug_string', $auto_updates_string, $plugin_path, $plugin, $enabled );
+
+                $plugin_version_string       .= ' | ' . $auto_updates_string;
+                $plugin_version_string_debug .= ', ' . $auto_updates_string;
+            }
+
+            $fields[ $plugin_part ][ sanitize_text_field( $plugin['Name'] ) ] = array(
+                'label' => $plugin['Name'],
+                'value' => $plugin_version_string,
+                'debug' => $plugin_version_string_debug,
+            );
+        }
+
+        return $fields;
+    }
+
+    /**
      * Gets the WordPress constants section of the debug data.
      *