<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58964] trunk/src/wp-admin/includes/class-wp-debug-data.php: WP_Debug_Data: Extract `wp-database` data into separate method.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58964">58964</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58964","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dmsnell</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-02 20:43:00 +0000 (Mon, 02 Sep 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/61648">#61648</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpdebugdataphp">trunk/src/wp-admin/includes/class-wp-debug-data.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpdebugdataphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-debug-data.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-debug-data.php 2024-09-02 00:11:39 UTC (rev 58963)
+++ trunk/src/wp-admin/includes/class-wp-debug-data.php 2024-09-02 20:43:00 UTC (rev 58964)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,15 +27,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0 Added database charset, database collation,
</span><span class="cx" style="display: block; padding: 0 10px"> * and timezone information.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 Added pretty permalinks support information.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.7.0 Modularized into separate theme-oriented methods.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @throws ImagickException
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global wpdb $wpdb WordPress database abstraction object.
</del><span class="cx" style="display: block; padding: 0 10px"> * @global array $_wp_theme_features
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array The debug data for the site.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function debug_data() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wpdb, $_wp_theme_features;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $_wp_theme_features;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Save few function calls.
</span><span class="cx" style="display: block; padding: 0 10px"> $upload_dir = wp_upload_dir();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -694,80 +694,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'value' => wp_date( 'c', $_SERVER['REQUEST_TIME'] ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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' ),
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // List must use plugins if there are any.
</span><span class="cx" style="display: block; padding: 0 10px"> $mu_plugins = get_mu_plugins();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1229,6 +1155,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $info['wp-constants'] = self::get_wp_constants();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $info['wp-database'] = self::get_wp_database();
</ins><span class="cx" style="display: block; padding: 0 10px"> $info['wp-filesystem'] = self::get_wp_filesystem();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1448,6 +1375,90 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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,
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Gets the file system section of the debug data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.7.0
</span></span></pre>
</div>
</div>
</body>
</html>