<!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>[59172] trunk/src/wp-admin/includes/class-wp-debug-data.php: WP_Debug_Data: Extract `wp-plugins` 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/59172">59172</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/59172","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-04 22:10:46 +0000 (Fri, 04 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-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 <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-04 17:34:50 UTC (rev 59171)
+++ trunk/src/wp-admin/includes/class-wp-debug-data.php 2024-10-04 22:10:46 UTC (rev 59172)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -82,8 +82,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-parent-theme' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-themes-inactive' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-mu-plugins' => self::get_wp_mu_plugins(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'wp-plugins-active' => array(),
- 'wp-plugins-inactive' => array(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp-plugins-active' => self::get_wp_plugins_active(),
+ 'wp-plugins-inactive' => self::get_wp_plugins_inactive(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'wp-media' => self::get_wp_media(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-server' => self::get_wp_server(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-database' => self::get_wp_database(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -188,18 +188,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">- $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(),
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Conditionally add debug information for multisite setups.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_multisite() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $site_id = get_current_blog_id();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,112 +313,6 @@
</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">- // 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,
- );
- }
-
</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">@@ -1289,6 +1171,157 @@
</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 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;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Gets the WordPress constants 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>