Changeset 58964

Timestamp:

09/02/2024 08:43:00 PM (15 months ago)

Author:

dmsnell

Message:

WP_Debug_Data: Extract wp-database data into separate method.

This is the part three 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 third of twelve groups, the wp-database info, into a separate method focused on that data.

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/7143
Discussed in https://core.trac.wordpress.org/ticket/61648

Props dmsnell, kebbet, apermo.
See #61648.

File:

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

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

@@ -28 +28 @@
      *              and timezone information.
      * @since 5.5.0 Added pretty permalinks support information.
+     * @since 6.7.0 Modularized into separate theme-oriented methods.
      *
      * @throws ImagickException
-     * @global wpdb  $wpdb               WordPress database abstraction object.
      * @global array $_wp_theme_features
      *
@@ -36 +36 @@
      */
     public static function debug_data() {
-        global $wpdb, $_wp_theme_features;
+        global $_wp_theme_features;
 
         // Save few function calls.
@@ -693 +693 @@
             'label' => __( 'Current Server time' ),
             'value' => wp_date( 'c', $_SERVER['REQUEST_TIME'] ),
-        );
-
-        // Populate the database debug fields.
-        if ( is_object( $wpdb->dbh ) ) {
-            // mysqli or PDO.
-            $extension = get_class( $wpdb->dbh );
-        } else {
-            // Unknown sql extension.
-            $extension = null;
-        }
-
-        $server = $wpdb->get_var( 'SELECT VERSION()' );
-
-        $client_version = $wpdb->dbh->client_info;
-
-        $info['wp-database']['fields']['extension'] = array(
-            'label' => __( 'Extension' ),
-            'value' => $extension,
-        );
-
-        $info['wp-database']['fields']['server_version'] = array(
-            'label' => __( 'Server version' ),
-            'value' => $server,
-        );
-
-        $info['wp-database']['fields']['client_version'] = array(
-            'label' => __( 'Client version' ),
-            'value' => $client_version,
-        );
-
-        $info['wp-database']['fields']['database_user'] = array(
-            'label'   => __( 'Database username' ),
-            'value'   => $wpdb->dbuser,
-            'private' => true,
-        );
-
-        $info['wp-database']['fields']['database_host'] = array(
-            'label'   => __( 'Database host' ),
-            'value'   => $wpdb->dbhost,
-            'private' => true,
-        );
-
-        $info['wp-database']['fields']['database_name'] = array(
-            'label'   => __( 'Database name' ),
-            'value'   => $wpdb->dbname,
-            'private' => true,
-        );
-
-        $info['wp-database']['fields']['database_prefix'] = array(
-            'label'   => __( 'Table prefix' ),
-            'value'   => $wpdb->prefix,
-            'private' => true,
-        );
-
-        $info['wp-database']['fields']['database_charset'] = array(
-            'label'   => __( 'Database charset' ),
-            'value'   => $wpdb->charset,
-            'private' => true,
-        );
-
-        $info['wp-database']['fields']['database_collate'] = array(
-            'label'   => __( 'Database collation' ),
-            'value'   => $wpdb->collate,
-            'private' => true,
-        );
-
-        $info['wp-database']['fields']['max_allowed_packet'] = array(
-            'label' => __( 'Max allowed packet size' ),
-            'value' => self::get_mysql_var( 'max_allowed_packet' ),
-        );
-
-        $info['wp-database']['fields']['max_connections'] = array(
-            'label' => __( 'Max connections number' ),
-            'value' => self::get_mysql_var( 'max_connections' ),
         );
 
@@ -1230 +1156 @@
 
         $info['wp-constants']  = self::get_wp_constants();
+        $info['wp-database']   = self::get_wp_database();
         $info['wp-filesystem'] = self::get_wp_filesystem();
 
@@ -1449 +1376 @@
 
     /**
+     * Gets the WordPress database section of the debug data.
+     *
+     * @since 6.7.0
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     *
+     * @return array
+     */
+    public static function get_wp_database(): array {
+        global $wpdb;
+
+        // Populate the database debug fields.
+        if ( is_object( $wpdb->dbh ) ) {
+            // mysqli or PDO.
+            $extension = get_class( $wpdb->dbh );
+        } else {
+            // Unknown sql extension.
+            $extension = null;
+        }
+
+        $server = $wpdb->get_var( 'SELECT VERSION()' );
+
+        $client_version = $wpdb->dbh->client_info;
+
+        $fields = array(
+            'extension'          => array(
+                'label' => __( 'Database Extension' ),
+                'value' => $extension,
+            ),
+            'server_version'     => array(
+                'label' => __( 'Server version' ),
+                'value' => $server,
+            ),
+            'client_version'     => array(
+                'label' => __( 'Client version' ),
+                'value' => $client_version,
+            ),
+            'database_user'      => array(
+                'label'   => __( 'Database username' ),
+                'value'   => $wpdb->dbuser,
+                'private' => true,
+            ),
+            'database_host'      => array(
+                'label'   => __( 'Database host' ),
+                'value'   => $wpdb->dbhost,
+                'private' => true,
+            ),
+            'database_name'      => array(
+                'label'   => __( 'Database name' ),
+                'value'   => $wpdb->dbname,
+                'private' => true,
+            ),
+            'database_prefix'    => array(
+                'label'   => __( 'Table prefix' ),
+                'value'   => $wpdb->prefix,
+                'private' => true,
+            ),
+            'database_charset'   => array(
+                'label'   => __( 'Database charset' ),
+                'value'   => $wpdb->charset,
+                'private' => true,
+            ),
+            'database_collate'   => array(
+                'label'   => __( 'Database collation' ),
+                'value'   => $wpdb->collate,
+                'private' => true,
+            ),
+            'max_allowed_packet' => array(
+                'label' => __( 'Max allowed packet size' ),
+                'value' => self::get_mysql_var( 'max_allowed_packet' ),
+            ),
+            'max_connections'    => array(
+                'label' => __( 'Max connections number' ),
+                'value' => self::get_mysql_var( 'max_connections' ),
+            ),
+        );
+
+        return array(
+            'label'  => __( 'Database' ),
+            'fields' => $fields,
+        );
+    }
+
+    /**
      * Gets the file system section of the debug data.
      *