<!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>[59174] trunk/src/wp-admin/includes/class-wp-debug-data.php: WP_Debug_Data: Extract `wp-core` data into separate methods.</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/59174">59174</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/59174","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-10-05 15:57:06 +0000 (Sat, 05 Oct 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-core` data into separate methods.
This is the ninth 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 tenth of twelve groups, the `wp-core` 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/pull/7357
Discussed in https://core.trac.wordpress.org/ticket/61648
Props apermo, dmsnell.
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-10-05 09:43:22 UTC (rev 59173)
+++ trunk/src/wp-admin/includes/class-wp-debug-data.php 2024-10-05 15:57:06 UTC (rev 59174)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,28 +39,8 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $permalink_structure = get_option( 'permalink_structure' );
- $is_ssl = is_ssl();
</del><span class="cx" style="display: block; padding: 0 10px"> $is_multisite = is_multisite();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $users_can_register = get_option( 'users_can_register' );
- $blog_public = get_option( 'blog_public' );
- $default_comment_status = get_option( 'default_comment_status' );
- $environment_type = wp_get_environment_type();
- $core_version = wp_get_wp_version();
- $core_updates = get_core_updates();
- $core_update_needed = '';
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_array( $core_updates ) ) {
- foreach ( $core_updates as $core => $update ) {
- if ( 'upgrade' === $update->response ) {
- /* translators: %s: Latest WordPress version number. */
- $core_update_needed = ' ' . sprintf( __( '(Latest version: %s)' ), $update->version );
- } else {
- $core_update_needed = '';
- }
- }
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Set up the array that holds all debug information.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,7 +55,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 61648
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $info = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'wp-core' => array(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp-core' => self::get_wp_core(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'wp-paths-sizes' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-dropins' => self::get_wp_dropins(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-active-theme' => array(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,74 +76,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $info['wp-paths-sizes'] );
</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">- $info['wp-core'] = array(
- 'label' => __( 'WordPress' ),
- 'fields' => array(
- 'version' => array(
- 'label' => __( 'Version' ),
- 'value' => $core_version . $core_update_needed,
- 'debug' => $core_version,
- ),
- 'site_language' => array(
- 'label' => __( 'Site Language' ),
- 'value' => get_locale(),
- ),
- 'user_language' => array(
- 'label' => __( 'User Language' ),
- 'value' => get_user_locale(),
- ),
- 'timezone' => array(
- 'label' => __( 'Timezone' ),
- 'value' => wp_timezone_string(),
- ),
- 'home_url' => array(
- 'label' => __( 'Home URL' ),
- 'value' => get_bloginfo( 'url' ),
- 'private' => true,
- ),
- 'site_url' => array(
- 'label' => __( 'Site URL' ),
- 'value' => get_bloginfo( 'wpurl' ),
- 'private' => true,
- ),
- 'permalink' => array(
- 'label' => __( 'Permalink structure' ),
- 'value' => $permalink_structure ? $permalink_structure : __( 'No permalink structure set' ),
- 'debug' => $permalink_structure,
- ),
- 'https_status' => array(
- 'label' => __( 'Is this site using HTTPS?' ),
- 'value' => $is_ssl ? __( 'Yes' ) : __( 'No' ),
- 'debug' => $is_ssl,
- ),
- 'multisite' => array(
- 'label' => __( 'Is this a multisite?' ),
- 'value' => $is_multisite ? __( 'Yes' ) : __( 'No' ),
- 'debug' => $is_multisite,
- ),
- 'user_registration' => array(
- 'label' => __( 'Can anyone register on this site?' ),
- 'value' => $users_can_register ? __( 'Yes' ) : __( 'No' ),
- 'debug' => $users_can_register,
- ),
- 'blog_public' => array(
- 'label' => __( 'Is this site discouraging search engines?' ),
- 'value' => $blog_public ? __( 'No' ) : __( 'Yes' ),
- 'debug' => $blog_public,
- ),
- 'default_comment_status' => array(
- 'label' => __( 'Default comment status' ),
- 'value' => 'open' === $default_comment_status ? _x( 'Open', 'comment status' ) : _x( 'Closed', 'comment status' ),
- 'debug' => $default_comment_status,
- ),
- 'environment_type' => array(
- 'label' => __( 'Environment type' ),
- 'value' => $environment_type,
- 'debug' => $environment_type,
- ),
- ),
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! $is_multisite ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $info['wp-paths-sizes'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: Filesystem directory paths and storage sizes. */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -188,68 +100,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => array(),
</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">- // Conditionally add debug information for multisite setups.
- if ( is_multisite() ) {
- $site_id = get_current_blog_id();
-
- $info['wp-core']['fields']['site_id'] = array(
- 'label' => __( 'Site ID' ),
- 'value' => $site_id,
- 'debug' => $site_id,
- );
-
- $network_query = new WP_Network_Query();
- $network_ids = $network_query->query(
- array(
- 'fields' => 'ids',
- 'number' => 100,
- 'no_found_rows' => false,
- )
- );
-
- $site_count = 0;
- foreach ( $network_ids as $network_id ) {
- $site_count += get_blog_count( $network_id );
- }
-
- $info['wp-core']['fields']['site_count'] = array(
- 'label' => __( 'Site count' ),
- 'value' => $site_count,
- );
-
- $info['wp-core']['fields']['network_count'] = array(
- 'label' => __( 'Network count' ),
- 'value' => $network_query->found_networks,
- );
- }
-
- $info['wp-core']['fields']['user_count'] = array(
- 'label' => __( 'User count' ),
- 'value' => get_user_count(),
- );
-
- // WordPress features requiring processing.
- $wp_dotorg = wp_remote_get( 'https://wordpress.org', array( 'timeout' => 10 ) );
-
- if ( ! is_wp_error( $wp_dotorg ) ) {
- $info['wp-core']['fields']['dotorg_communication'] = array(
- 'label' => __( 'Communication with WordPress.org' ),
- 'value' => __( 'WordPress.org is reachable' ),
- 'debug' => 'true',
- );
- } else {
- $info['wp-core']['fields']['dotorg_communication'] = array(
- 'label' => __( 'Communication with WordPress.org' ),
- 'value' => sprintf(
- /* translators: 1: The IP address WordPress.org resolves to. 2: The error returned by the lookup. */
- __( 'Unable to reach WordPress.org at %1$s: %2$s' ),
- gethostbyname( 'wordpress.org' ),
- $wp_dotorg->get_error_message()
- ),
- 'debug' => $wp_dotorg->get_error_message(),
- );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Remove accordion for Directories and Sizes if in Multisite.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $is_multisite ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $loading = __( 'Loading…' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -698,6 +548,169 @@
</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 core section of the debug data.
+ *
+ * @since 6.7.0
+ *
+ * @return array
+ */
+ private static function get_wp_core(): array {
+ // Save few function calls.
+ $permalink_structure = get_option( 'permalink_structure' );
+ $is_ssl = is_ssl();
+ $users_can_register = get_option( 'users_can_register' );
+ $blog_public = get_option( 'blog_public' );
+ $default_comment_status = get_option( 'default_comment_status' );
+ $environment_type = wp_get_environment_type();
+ $core_version = wp_get_wp_version();
+ $core_updates = get_core_updates();
+ $core_update_needed = '';
+
+ if ( is_array( $core_updates ) ) {
+ foreach ( $core_updates as $core => $update ) {
+ if ( 'upgrade' === $update->response ) {
+ /* translators: %s: Latest WordPress version number. */
+ $core_update_needed = ' ' . sprintf( __( '(Latest version: %s)' ), $update->version );
+ } else {
+ $core_update_needed = '';
+ }
+ }
+ }
+
+ $fields = array(
+ 'version' => array(
+ 'label' => __( 'Version' ),
+ 'value' => $core_version . $core_update_needed,
+ 'debug' => $core_version,
+ ),
+ 'site_language' => array(
+ 'label' => __( 'Site Language' ),
+ 'value' => get_locale(),
+ ),
+ 'user_language' => array(
+ 'label' => __( 'User Language' ),
+ 'value' => get_user_locale(),
+ ),
+ 'timezone' => array(
+ 'label' => __( 'Timezone' ),
+ 'value' => wp_timezone_string(),
+ ),
+ 'home_url' => array(
+ 'label' => __( 'Home URL' ),
+ 'value' => get_bloginfo( 'url' ),
+ 'private' => true,
+ ),
+ 'site_url' => array(
+ 'label' => __( 'Site URL' ),
+ 'value' => get_bloginfo( 'wpurl' ),
+ 'private' => true,
+ ),
+ 'permalink' => array(
+ 'label' => __( 'Permalink structure' ),
+ 'value' => $permalink_structure ? $permalink_structure : __( 'No permalink structure set' ),
+ 'debug' => $permalink_structure,
+ ),
+ 'https_status' => array(
+ 'label' => __( 'Is this site using HTTPS?' ),
+ 'value' => $is_ssl ? __( 'Yes' ) : __( 'No' ),
+ 'debug' => $is_ssl,
+ ),
+ 'multisite' => array(
+ 'label' => __( 'Is this a multisite?' ),
+ 'value' => is_multisite() ? __( 'Yes' ) : __( 'No' ),
+ 'debug' => is_multisite(),
+ ),
+ 'user_registration' => array(
+ 'label' => __( 'Can anyone register on this site?' ),
+ 'value' => $users_can_register ? __( 'Yes' ) : __( 'No' ),
+ 'debug' => $users_can_register,
+ ),
+ 'blog_public' => array(
+ 'label' => __( 'Is this site discouraging search engines?' ),
+ 'value' => $blog_public ? __( 'No' ) : __( 'Yes' ),
+ 'debug' => $blog_public,
+ ),
+ 'default_comment_status' => array(
+ 'label' => __( 'Default comment status' ),
+ 'value' => 'open' === $default_comment_status ? _x( 'Open', 'comment status' ) : _x( 'Closed', 'comment status' ),
+ 'debug' => $default_comment_status,
+ ),
+ 'environment_type' => array(
+ 'label' => __( 'Environment type' ),
+ 'value' => $environment_type,
+ 'debug' => $environment_type,
+ ),
+ );
+
+ // Conditionally add debug information for multisite setups.
+ if ( is_multisite() ) {
+ $site_id = get_current_blog_id();
+
+ $fields['site_id'] = array(
+ 'label' => __( 'Site ID' ),
+ 'value' => $site_id,
+ 'debug' => $site_id,
+ );
+
+ $network_query = new WP_Network_Query();
+ $network_ids = $network_query->query(
+ array(
+ 'fields' => 'ids',
+ 'number' => 100,
+ 'no_found_rows' => false,
+ )
+ );
+
+ $site_count = 0;
+ foreach ( $network_ids as $network_id ) {
+ $site_count += get_blog_count( $network_id );
+ }
+
+ $fields['site_count'] = array(
+ 'label' => __( 'Site count' ),
+ 'value' => $site_count,
+ );
+
+ $fields['network_count'] = array(
+ 'label' => __( 'Network count' ),
+ 'value' => $network_query->found_networks,
+ );
+ }
+
+ $fields['user_count'] = array(
+ 'label' => __( 'User count' ),
+ 'value' => get_user_count(),
+ );
+
+ // WordPress features requiring processing.
+ $wp_dotorg = wp_remote_get( 'https://wordpress.org', array( 'timeout' => 10 ) );
+
+ if ( ! is_wp_error( $wp_dotorg ) ) {
+ $fields['dotorg_communication'] = array(
+ 'label' => __( 'Communication with WordPress.org' ),
+ 'value' => __( 'WordPress.org is reachable' ),
+ 'debug' => 'true',
+ );
+ } else {
+ $fields['dotorg_communication'] = array(
+ 'label' => __( 'Communication with WordPress.org' ),
+ 'value' => sprintf(
+ /* translators: 1: The IP address WordPress.org resolves to. 2: The error returned by the lookup. */
+ __( 'Unable to reach WordPress.org at %1$s: %2$s' ),
+ gethostbyname( 'wordpress.org' ),
+ $wp_dotorg->get_error_message()
+ ),
+ 'debug' => $wp_dotorg->get_error_message(),
+ );
+ }
+
+ return array(
+ 'label' => __( 'WordPress' ),
+ 'fields' => $fields,
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Gets the WordPress drop-in 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>