<!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>[59175] trunk/src/wp-admin/includes/class-wp-debug-data.php: WP_Debug_Data: Extract `wp-paths-sizes` 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/59175">59175</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/59175","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 16:26:17 +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-paths-sizes` data into separate methods.
This is the tenth 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 eleventh of twelve groups, the `wp-paths-sizes` 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/7445
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 15:57:06 UTC (rev 59174)
+++ trunk/src/wp-admin/includes/class-wp-debug-data.php 2024-10-05 16:26:17 UTC (rev 59175)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,7 +56,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $info = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-core' => self::get_wp_core(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'wp-paths-sizes' => array(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp-paths-sizes' => self::get_wp_paths_sizes(),
</ins><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="cx" style="display: block; padding: 0 10px"> 'wp-parent-theme' => array(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -71,19 +71,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> '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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Remove debug data which is only relevant on single-site installs.
- if ( is_multisite() ) {
- unset( $info['wp-paths-sizes'] );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Remove null elements from the array. The individual methods are
+ * allowed to return `null`, which communicates that the category
+ * of debug data isn't relevant and shouldn't be passed through.
+ */
+ $info = array_filter(
+ $info,
+ static function ( $section ) {
+ return isset( $section );
+ }
+ );
</ins><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_multisite ) {
- $info['wp-paths-sizes'] = array(
- /* translators: Filesystem directory paths and storage sizes. */
- 'label' => __( 'Directories and Sizes' ),
- 'fields' => array(),
- );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $info['wp-active-theme'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'label' => __( 'Active Theme' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => array(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,69 +99,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">- // Remove accordion for Directories and Sizes if in Multisite.
- if ( ! $is_multisite ) {
- $loading = __( 'Loading…' );
-
- $info['wp-paths-sizes']['fields'] = array(
- 'wordpress_path' => array(
- 'label' => __( 'WordPress directory location' ),
- 'value' => untrailingslashit( ABSPATH ),
- ),
- 'wordpress_size' => array(
- 'label' => __( 'WordPress directory size' ),
- 'value' => $loading,
- 'debug' => 'loading...',
- ),
- 'uploads_path' => array(
- 'label' => __( 'Uploads directory location' ),
- 'value' => $upload_dir['basedir'],
- ),
- 'uploads_size' => array(
- 'label' => __( 'Uploads directory size' ),
- 'value' => $loading,
- 'debug' => 'loading...',
- ),
- 'themes_path' => array(
- 'label' => __( 'Themes directory location' ),
- 'value' => get_theme_root(),
- ),
- 'themes_size' => array(
- 'label' => __( 'Themes directory size' ),
- 'value' => $loading,
- 'debug' => 'loading...',
- ),
- 'plugins_path' => array(
- 'label' => __( 'Plugins directory location' ),
- 'value' => WP_PLUGIN_DIR,
- ),
- 'plugins_size' => array(
- 'label' => __( 'Plugins directory size' ),
- 'value' => $loading,
- 'debug' => 'loading...',
- ),
- 'fonts_path' => array(
- 'label' => __( 'Fonts directory location' ),
- 'value' => wp_get_font_dir()['basedir'],
- ),
- 'fonts_size' => array(
- 'label' => __( 'Fonts directory size' ),
- 'value' => $loading,
- 'debug' => 'loading...',
- ),
- 'database_size' => array(
- 'label' => __( 'Database size' ),
- 'value' => $loading,
- 'debug' => 'loading...',
- ),
- 'total_size' => array(
- 'label' => __( 'Total installation size' ),
- 'value' => $loading,
- 'debug' => 'loading...',
- ),
- );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Populate the section for the currently active theme.
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_features = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1133,7 +1069,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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Gets the WordPress plugins section of the debug data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets the WordPress MU plugins section of the debug data.
</ins><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 class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1184,6 +1120,86 @@
</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 paths and sizes section of the debug data.
+ *
+ * @since 6.7.0
+ *
+ * @return array|null Paths and sizes debug data for single sites,
+ * otherwise `null` for multi-site installs.
+ */
+ private static function get_wp_paths_sizes(): ?array {
+ if ( is_multisite() ) {
+ return null;
+ }
+
+ $loading = __( 'Loading…' );
+
+ $fields = array(
+ 'wordpress_path' => array(
+ 'label' => __( 'WordPress directory location' ),
+ 'value' => untrailingslashit( ABSPATH ),
+ ),
+ 'wordpress_size' => array(
+ 'label' => __( 'WordPress directory size' ),
+ 'value' => $loading,
+ 'debug' => 'loading...',
+ ),
+ 'uploads_path' => array(
+ 'label' => __( 'Uploads directory location' ),
+ 'value' => wp_upload_dir()['basedir'],
+ ),
+ 'uploads_size' => array(
+ 'label' => __( 'Uploads directory size' ),
+ 'value' => $loading,
+ 'debug' => 'loading...',
+ ),
+ 'themes_path' => array(
+ 'label' => __( 'Themes directory location' ),
+ 'value' => get_theme_root(),
+ ),
+ 'themes_size' => array(
+ 'label' => __( 'Themes directory size' ),
+ 'value' => $loading,
+ 'debug' => 'loading...',
+ ),
+ 'plugins_path' => array(
+ 'label' => __( 'Plugins directory location' ),
+ 'value' => WP_PLUGIN_DIR,
+ ),
+ 'plugins_size' => array(
+ 'label' => __( 'Plugins directory size' ),
+ 'value' => $loading,
+ 'debug' => 'loading...',
+ ),
+ 'fonts_path' => array(
+ 'label' => __( 'Fonts directory location' ),
+ 'value' => wp_get_font_dir()['basedir'],
+ ),
+ 'fonts_size' => array(
+ 'label' => __( 'Fonts directory size' ),
+ 'value' => $loading,
+ 'debug' => 'loading...',
+ ),
+ 'database_size' => array(
+ 'label' => __( 'Database size' ),
+ 'value' => $loading,
+ 'debug' => 'loading...',
+ ),
+ 'total_size' => array(
+ 'label' => __( 'Total installation size' ),
+ 'value' => $loading,
+ 'debug' => 'loading...',
+ ),
+ );
+
+ return array(
+ /* translators: Filesystem directory paths and storage sizes. */
+ 'label' => __( 'Directories and Sizes' ),
+ 'fields' => $fields,
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Gets the WordPress active plugins 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>