diff --git a/wp-admin/includes/class-wp-debug-data.php b/wp-admin/includes/class-wp-debug-data.php index 4884de2700..05545efa85 100644 --- a/wp-admin/includes/class-wp-debug-data.php +++ b/wp-admin/includes/class-wp-debug-data.php @@ -30,18 +30,19 @@ class WP_Debug_Data { * @param string $locale Optional. An ISO formatted language code to provide debug translations in. Default null. * @return array The debug data for the site. */ - static function debug_data( $locale = null ) { + static function debug_data() { global $wpdb; - if ( ! empty( $locale ) ) { - // Change the language used for translations - $original_locale = get_user_locale(); - $switched_locale = switch_to_locale( $locale ); - } - $upload_dir = wp_get_upload_dir(); - $core_current_version = get_bloginfo( 'version' ); - $core_updates = get_core_updates(); - $core_update_needed = ''; + // Save few function calls. + $locale = get_user_locale(); + $upload_dir = wp_get_upload_dir(); + $permalink_structure = get_option( 'permalink_structure' ); + $is_ssl = is_ssl(); + $users_can_register = get_option( 'users_can_register' ); + $is_multisite = is_multisite(); + $core_version = get_bloginfo( 'version' ); + $core_updates = get_core_updates(); + $core_update_needed = ''; foreach ( $core_updates as $core => $update ) { if ( 'upgrade' === $update->response ) { @@ -53,188 +54,272 @@ class WP_Debug_Data { } // Set up the array that holds all debug information. - $info = array( - 'wp-core' => array( - 'label' => __( 'WordPress' ), - 'fields' => array( - 'version' => array( - 'label' => __( 'Version' ), - 'value' => $core_current_version . $core_update_needed, - ), - 'language' => array( - 'label' => __( 'Language' ), - 'value' => ( ! empty( $locale ) ? $original_locale : get_user_locale() ), - ), - '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' => get_option( 'permalink_structure' ) ?: __( 'No permalink structure set' ), - ), - 'https_status' => array( - 'label' => __( 'Is this site using HTTPS?' ), - 'value' => ( is_ssl() ? __( 'Yes' ) : __( 'No' ) ), - ), - 'user_registration' => array( - 'label' => __( 'Can anyone register on this site?' ), - 'value' => ( get_option( 'users_can_register' ) ? __( 'Yes' ) : __( 'No' ) ), - ), - 'default_comment_status' => array( - 'label' => __( 'Default comment status' ), - 'value' => get_option( 'default_comment_status' ), - ), - 'multisite' => array( - 'label' => __( 'Is this a multisite?' ), - 'value' => ( is_multisite() ? __( 'Yes' ) : __( 'No' ) ), - ), + $info = array(); + + $info['wp-core'] = array( + 'label' => __( 'WordPress' ), + 'fields' => array( + 'version' => array( + 'label' => __( 'Version' ), + 'value' => $core_version . $core_update_needed, + 'debug' => $core_version, + ), + 'language' => array( + 'label' => __( 'Language' ), + 'value' => $locale, + ), + '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 ?: __( 'No permalink structure set' ), + 'debug' => $permalink_structure, + ), + 'https_status' => array( + 'label' => __( 'Is this site using HTTPS?' ), + 'value' => ( $is_ssl ? __( 'Yes' ) : __( 'No' ) ), + 'debug' => $is_ssl, + ), + 'user_registration' => array( + 'label' => __( 'Can anyone register on this site?' ), + 'value' => ( $users_can_register ? __( 'Yes' ) : __( 'No' ) ), + 'debug' => $users_can_register, + ), + 'default_comment_status' => array( + 'label' => __( 'Default comment status' ), + 'value' => get_option( 'default_comment_status' ), + ), + 'multisite' => array( + 'label' => __( 'Is this a multisite?' ), + 'value' => ( $is_multisite ? __( 'Yes' ) : __( 'No' ) ), + 'debug' => $is_multisite, ), ), - 'wp-paths-sizes' => array( - 'label' => __( 'Directories and Sizes' ), - 'fields' => array(), - ), - 'wp-dropins' => array( - 'label' => __( 'Drop-ins' ), - 'show_count' => true, - 'description' => __( 'Drop-ins are single files that replace or enhance WordPress features in ways that are not possible for traditional plugins.' ), - 'fields' => array(), - ), - 'wp-active-theme' => array( - 'label' => __( 'Active Theme' ), - 'fields' => array(), - ), - 'wp-themes' => array( - 'label' => __( 'Other Themes' ), - 'show_count' => true, - 'fields' => array(), - ), - 'wp-mu-plugins' => array( - 'label' => __( 'Must Use Plugins' ), - 'show_count' => true, - 'fields' => array(), - ), - 'wp-plugins-active' => array( - 'label' => __( 'Active Plugins' ), - 'show_count' => true, - 'fields' => array(), - ), - 'wp-plugins-inactive' => array( - 'label' => __( 'Inactive Plugins' ), - 'show_count' => true, - 'fields' => array(), - ), - 'wp-media' => array( - 'label' => __( 'Media Handling' ), - 'fields' => array(), - ), - 'wp-server' => array( - 'label' => __( 'Server' ), - 'description' => __( 'The options shown below relate to your server setup. If changes are required, you may need your web host’s assistance.' ), - 'fields' => array(), - ), - 'wp-database' => array( - 'label' => __( 'Database' ), - 'fields' => array(), - ), - 'wp-constants' => array( - 'label' => __( 'WordPress Constants' ), - 'description' => __( 'These settings alter where and how parts of WordPress are loaded.' ), - 'fields' => array( - 'ABSPATH' => array( - 'label' => 'ABSPATH', - 'value' => ABSPATH, - 'private' => true, - ), - 'WP_HOME' => array( - 'label' => 'WP_HOME', - 'value' => ( ! defined( 'WP_HOME' ) ? __( 'Undefined' ) : WP_HOME ), - ), - 'WP_SITEURL' => array( - 'label' => 'WP_SITEURL', - 'value' => ( ! defined( 'WP_SITEURL' ) ? __( 'Undefined' ) : WP_SITEURL ), - ), - 'WP_CONTENT_DIR' => array( - 'label' => 'WP_CONTENT_DIR', - 'value' => WP_CONTENT_DIR, - ), - 'WP_PLUGIN_DIR' => array( - 'label' => 'WP_PLUGIN_DIR', - 'value' => WP_PLUGIN_DIR, - ), - 'WP_DEBUG' => array( - 'label' => 'WP_DEBUG', - 'value' => WP_DEBUG ? __( 'Enabled' ) : __( 'Disabled' ), - ), - 'WP_MAX_MEMORY_LIMIT' => array( - 'label' => 'WP_MAX_MEMORY_LIMIT', - 'value' => WP_MAX_MEMORY_LIMIT, - ), - 'WP_DEBUG_DISPLAY' => array( - 'label' => 'WP_DEBUG_DISPLAY', - 'value' => WP_DEBUG_DISPLAY ? __( 'Enabled' ) : __( 'Disabled' ), - ), - 'WP_DEBUG_LOG' => array( - 'label' => 'WP_DEBUG_LOG', - 'value' => ( is_string( WP_DEBUG_LOG ) ? WP_DEBUG_LOG : ( WP_DEBUG_LOG ? __( 'Enabled' ) : __( 'Disabled' ) ) ), - ), - 'SCRIPT_DEBUG' => array( - 'label' => 'SCRIPT_DEBUG', - 'value' => SCRIPT_DEBUG ? __( 'Enabled' ) : __( 'Disabled' ), - ), - 'WP_CACHE' => array( - 'label' => 'WP_CACHE', - 'value' => WP_CACHE ? __( 'Enabled' ) : __( 'Disabled' ), - ), - 'CONCATENATE_SCRIPTS' => array( - 'label' => 'CONCATENATE_SCRIPTS', - 'value' => ( ! defined( 'CONCATENATE_SCRIPTS' ) ? __( 'Undefined' ) : ( CONCATENATE_SCRIPTS ? __( 'Enabled' ) : __( 'Disabled' ) ) ), - ), - 'COMPRESS_SCRIPTS' => array( - 'label' => 'COMPRESS_SCRIPTS', - 'value' => ( ! defined( 'COMPRESS_SCRIPTS' ) ? __( 'Undefined' ) : ( COMPRESS_SCRIPTS ? __( 'Enabled' ) : __( 'Disabled' ) ) ), - ), - 'COMPRESS_CSS' => array( - 'label' => 'COMPRESS_CSS', - 'value' => ( ! defined( 'COMPRESS_CSS' ) ? __( 'Undefined' ) : ( COMPRESS_CSS ? __( 'Enabled' ) : __( 'Disabled' ) ) ), - ), - 'WP_LOCAL_DEV' => array( - 'label' => 'WP_LOCAL_DEV', - 'value' => ( ! defined( 'WP_LOCAL_DEV' ) ? __( 'Undefined' ) : ( WP_LOCAL_DEV ? __( 'Enabled' ) : __( 'Disabled' ) ) ), - ), + ); + + $info['wp-paths-sizes'] = array( + 'label' => __( 'Directories and Sizes' ), + 'fields' => array(), + ); + + $info['wp-dropins'] = array( + 'label' => __( 'Drop-ins' ), + 'show_count' => true, + 'description' => __( 'Drop-ins are single files that replace or enhance WordPress features in ways that are not possible for traditional plugins.' ), + 'fields' => array(), + ); + + $info['wp-active-theme'] = array( + 'label' => __( 'Active Theme' ), + 'fields' => array(), + ); + + $info['wp-themes'] = array( + 'label' => __( 'Other Themes' ), + 'show_count' => true, + 'fields' => array(), + ); + + $info['wp-mu-plugins'] = array( + 'label' => __( 'Must Use Plugins' ), + 'show_count' => true, + 'fields' => array(), + ); + + $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(), + ); + + $info['wp-media'] = array( + 'label' => __( 'Media Handling' ), + 'fields' => array(), + ); + + $info['wp-server'] = array( + 'label' => __( 'Server' ), + 'description' => __( 'The options shown below relate to your server setup. If changes are required, you may need your web host’s assistance.' ), + 'fields' => array(), + ); + + $info['wp-database'] = array( + 'label' => __( 'Database' ), + 'fields' => array(), + ); + + // Check if WP_DEBUG_LOG is set. + $wp_debug_log_value = __( 'Disabled' ); + + if ( is_string( WP_DEBUG_LOG ) ) { + $wp_debug_log_value = WP_DEBUG_LOG; + } elseif ( WP_DEBUG_LOG ) { + $wp_debug_log_value = __( 'Enabled' ); + } + + // Check CONCATENATE_SCRIPTS. + if ( defined( 'CONCATENATE_SCRIPTS' ) ) { + $concatenate_scripts = CONCATENATE_SCRIPTS ? __( 'Enabled' ) : __( 'Disabled' ); + $concatenate_scripts_debug = CONCATENATE_SCRIPTS ? 'true' : 'false'; + } else { + $concatenate_scripts = __( 'Undefined' ); + $concatenate_scripts_debug = 'undefined'; + } + + // Check COMPRESS_SCRIPTS. + if ( defined( 'COMPRESS_SCRIPTS' ) ) { + $compress_scripts = COMPRESS_SCRIPTS ? __( 'Enabled' ) : __( 'Disabled' ); + $compress_scripts_debug = COMPRESS_SCRIPTS ? 'true' : 'false'; + } else { + $compress_scripts = __( 'Undefined' ); + $compress_scripts_debug = 'undefined'; + } + + // Check COMPRESS_CSS. + if ( defined( 'COMPRESS_CSS' ) ) { + $compress_css = COMPRESS_CSS ? __( 'Enabled' ) : __( 'Disabled' ); + $compress_css_debug = COMPRESS_CSS ? 'true' : 'false'; + } else { + $compress_css = __( 'Undefined' ); + $compress_css_debug = 'undefined'; + } + + // Check WP_LOCAL_DEV. + if ( defined( 'WP_LOCAL_DEV' ) ) { + $wp_local_dev = WP_LOCAL_DEV ? __( 'Enabled' ) : __( 'Disabled' ); + $wp_local_dev_debug = WP_LOCAL_DEV ? 'true' : 'false'; + } else { + $wp_local_dev = __( 'Undefined' ); + $wp_local_dev_debug = 'undefined'; + } + + $info['wp-constants'] = array( + 'label' => __( 'WordPress Constants' ), + 'description' => __( 'These settings alter where and how parts of WordPress are loaded.' ), + 'fields' => array( + 'ABSPATH' => array( + 'label' => 'ABSPATH', + 'value' => ABSPATH, + 'private' => true, + ), + 'WP_HOME' => array( + 'label' => 'WP_HOME', + 'value' => ( defined( 'WP_HOME' ) ? WP_HOME : __( 'Undefined' ) ), + 'debug' => ( defined( 'WP_HOME' ) ? WP_HOME : 'undefined' ), + ), + 'WP_SITEURL' => array( + 'label' => 'WP_SITEURL', + 'value' => ( defined( 'WP_SITEURL' ) ? WP_SITEURL : __( 'Undefined' ) ), + 'debug' => ( defined( 'WP_SITEURL' ) ? WP_SITEURL : 'undefined' ), + ), + 'WP_CONTENT_DIR' => array( + 'label' => 'WP_CONTENT_DIR', + 'value' => WP_CONTENT_DIR, + ), + 'WP_PLUGIN_DIR' => array( + 'label' => 'WP_PLUGIN_DIR', + 'value' => WP_PLUGIN_DIR, + ), + 'WP_DEBUG' => array( + 'label' => 'WP_DEBUG', + 'value' => WP_DEBUG ? __( 'Enabled' ) : __( 'Disabled' ), + 'debug' => WP_DEBUG, + ), + 'WP_MAX_MEMORY_LIMIT' => array( + 'label' => 'WP_MAX_MEMORY_LIMIT', + 'value' => WP_MAX_MEMORY_LIMIT, + ), + 'WP_DEBUG_DISPLAY' => array( + 'label' => 'WP_DEBUG_DISPLAY', + 'value' => WP_DEBUG_DISPLAY ? __( 'Enabled' ) : __( 'Disabled' ), + 'debug' => WP_DEBUG_DISPLAY, + ), + 'WP_DEBUG_LOG' => array( + 'label' => 'WP_DEBUG_LOG', + 'value' => $wp_debug_log_value, + 'debug' => WP_DEBUG_LOG, + ), + 'SCRIPT_DEBUG' => array( + 'label' => 'SCRIPT_DEBUG', + 'value' => SCRIPT_DEBUG ? __( 'Enabled' ) : __( 'Disabled' ), + 'debug' => SCRIPT_DEBUG, + ), + 'WP_CACHE' => array( + 'label' => 'WP_CACHE', + 'value' => WP_CACHE ? __( 'Enabled' ) : __( 'Disabled' ), + 'debug' => WP_CACHE, + ), + 'CONCATENATE_SCRIPTS' => array( + 'label' => 'CONCATENATE_SCRIPTS', + 'value' => $concatenate_scripts, + 'debug' => $concatenate_scripts_debug, + ), + 'COMPRESS_SCRIPTS' => array( + 'label' => 'COMPRESS_SCRIPTS', + 'value' => $compress_scripts, + 'debug' => $compress_scripts_debug, + ), + 'COMPRESS_CSS' => array( + 'label' => 'COMPRESS_CSS', + 'value' => $compress_css, + 'debug' => $compress_css_debug, + ), + 'WP_LOCAL_DEV' => array( + 'label' => 'WP_LOCAL_DEV', + 'value' => $wp_local_dev, + 'debug' => $wp_local_dev_debug, ), ), - 'wp-filesystem' => array( - 'label' => __( 'Filesystem Permissions' ), - 'description' => __( 'Shows whether WordPress is able to write to the directories it needs access to.' ), - 'fields' => array( - 'all' => array( - 'label' => __( 'The main WordPress directory' ), - 'value' => ( wp_is_writable( ABSPATH ) ? __( 'Writable' ) : __( 'Not writable' ) ), - ), - 'wp-content' => array( - 'label' => __( 'The wp-content directory' ), - 'value' => ( wp_is_writable( WP_CONTENT_DIR ) ? __( 'Writable' ) : __( 'Not writable' ) ), - ), - 'uploads' => array( - 'label' => __( 'The uploads directory' ), - 'value' => ( wp_is_writable( $upload_dir['basedir'] ) ? __( 'Writable' ) : __( 'Not writable' ) ), - ), - 'plugins' => array( - 'label' => __( 'The plugins directory' ), - 'value' => ( wp_is_writable( WP_PLUGIN_DIR ) ? __( 'Writable' ) : __( 'Not writable' ) ), - ), - 'themes' => array( - 'label' => __( 'The themes directory' ), - 'value' => ( wp_is_writable( get_template_directory() . '/..' ) ? __( 'Writable' ) : __( 'Not writable' ) ), - ), + ); + + $is_writable_abspath = wp_is_writable( ABSPATH ); + $is_writable_wp_content_dir = wp_is_writable( WP_CONTENT_DIR ); + $is_writable_upload_dir = wp_is_writable( $upload_dir['basedir'] ); + $is_writable_wp_plugin_dir = wp_is_writable( WP_PLUGIN_DIR ); + $is_writable_template_directory = wp_is_writable( get_template_directory() . '/..' ); + + $info['wp-filesystem'] = array( + 'label' => __( 'Filesystem Permissions' ), + 'description' => __( 'Shows whether WordPress is able to write to the directories it needs access to.' ), + 'fields' => array( + 'wordpress' => array( + 'label' => __( 'The main WordPress directory' ), + 'value' => ( $is_writable_abspath ? __( 'Writable' ) : __( 'Not writable' ) ), + 'debug' => ( $is_writable_abspath ? 'writable' : 'not writable' ), + ), + 'wp-content' => array( + 'label' => __( 'The wp-content directory' ), + 'value' => ( $is_writable_wp_content_dir ? __( 'Writable' ) : __( 'Not writable' ) ), + 'debug' => ( $is_writable_wp_content_dir ? 'writable' : 'not writable' ), + ), + 'uploads' => array( + 'label' => __( 'The uploads directory' ), + 'value' => ( $is_writable_upload_dir ? __( 'Writable' ) : __( 'Not writable' ) ), + 'debug' => ( $is_writable_upload_dir ? 'writable' : 'not writable' ), + ), + 'plugins' => array( + 'label' => __( 'The plugins directory' ), + 'value' => ( $is_writable_wp_plugin_dir ? __( 'Writable' ) : __( 'Not writable' ) ), + 'debug' => ( $is_writable_wp_plugin_dir ? 'writable' : 'not writable' ), + ), + 'themes' => array( + 'label' => __( 'The themes directory' ), + 'value' => ( $is_writable_template_directory ? __( 'Writable' ) : __( 'Not writable' ) ), + 'debug' => ( $is_writable_template_directory ? 'writable' : 'not writable' ), ), ), ); @@ -255,14 +340,16 @@ class WP_Debug_Data { $site_count += get_blog_count( $network_id ); } - $info['wp-core']['fields']['user_count'] = array( + $info['wp-core']['fields']['user_count'] = array( 'label' => __( 'User count' ), 'value' => get_user_count(), ); - $info['wp-core']['fields']['site_count'] = array( + + $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, @@ -277,18 +364,13 @@ class WP_Debug_Data { } // WordPress features requiring processing. - $wp_dotorg = wp_remote_get( - 'https://wordpress.org', - array( - 'timeout' => 10, - ) - ); + $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' => sprintf( - __( 'WordPress.org is reachable' ) - ), + 'value' => __( 'WordPress.org is reachable' ), + 'debug' => 'true', ); } else { $info['wp-core']['fields']['dotorg_communication'] = array( @@ -299,6 +381,7 @@ class WP_Debug_Data { gethostbyname( 'wordpress.org' ), $wp_dotorg->get_error_message() ), + 'debug' => $wp_dotorg->get_error_message(), ); } @@ -350,9 +433,7 @@ class WP_Debug_Data { ), ); - $timeout = __( 'The directory size calculation has timed out. Usually caused by a very large number of sub-directories and files.' ); - $inaccessible = __( 'The size cannot be calculated. The directory is not accessible. Usually caused by invalid permissions.' ); - $size_total = 0; + $size_total = 0; // Loop over all the directories we want to gather the sizes for. foreach ( $size_directories as $size => $attributes ) { @@ -362,90 +443,105 @@ class WP_Debug_Data { $dir_size = get_dirsize( $attributes['path'], $max_execution_time ); } - if ( $dir_size === false ) { + if ( false === $dir_size ) { // Error reading. - $dir_size = $inaccessible; + $size_directories[ $size ]['size'] = __( 'The size cannot be calculated. The directory is not accessible. Usually caused by invalid permissions.' ); + $size_directories[ $size ]['debug'] = 'not accessible'; + // Stop total size calculation. $size_total = null; - } elseif ( $dir_size === null ) { + } elseif ( null === $dir_size ) { // Timeout. - $dir_size = $timeout; + $size_directories[ $size ]['size'] = __( 'The directory size calculation has timed out. Usually caused by a very large number of sub-directories and files.' ); + $size_directories[ $size ]['debug'] = 'timeout while calculating size'; + // Stop total size calculation. $size_total = null; } else { $is_subdir = ( strpos( $size_directories[ $size ]['path'], ABSPATH ) === 0 ); // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled - if ( $size_total !== null && ( $size === 'wordpress' || ! $is_subdir ) ) { + if ( null !== $size_total && ( 'wordpress' === $size || ! $is_subdir ) ) { $size_total += $dir_size; } - $dir_size = size_format( $dir_size, 2 ); + $size_directories[ $size ]['size'] = size_format( $dir_size, 2 ); + $size_directories[ $size ]['debug'] = $size_directories[ $size ]['size']; } - - $size_directories[ $size ]['size'] = $dir_size; } - if ( $size_total !== null && $size_db > 0 ) { + if ( null !== $size_total && $size_db > 0 ) { $size_total = size_format( $size_total + $size_db, 2 ); } else { - $size_total = __( 'Total size is not available. Some errors were encountered when determining the size of your installation.' ); + $size_total = 0; } $info['wp-paths-sizes']['fields'] = array( - array( + 'uploads_path' => array( 'label' => __( 'Uploads Directory Location' ), 'value' => $size_directories['uploads']['path'], ), - array( + 'uploads_size' => array( 'label' => __( 'Uploads Directory Size' ), 'value' => $size_directories['uploads']['size'], + 'debug' => $size_directories['uploads']['debug'], ), - array( + 'themes_path' => array( 'label' => __( 'Themes Directory Location' ), 'value' => $size_directories['themes']['path'], ), - array( + 'current_theme_path' => array( 'label' => __( 'Current Theme Directory' ), 'value' => get_template_directory(), ), - array( + 'themes_size' => array( 'label' => __( 'Themes Directory Size' ), 'value' => $size_directories['themes']['size'], + 'debug' => $size_directories['themes']['debug'], ), - array( + 'plugins_path' => array( 'label' => __( 'Plugins Directory Location' ), 'value' => $size_directories['plugins']['path'], ), - array( + 'plugins_size' => array( 'label' => __( 'Plugins Directory Size' ), 'value' => $size_directories['plugins']['size'], + 'debug' => $size_directories['plugins']['debug'], ), - array( + 'wordpress_path' => array( 'label' => __( 'WordPress Directory Location' ), 'value' => $size_directories['wordpress']['path'], ), - array( + 'wordpress_size' => array( 'label' => __( 'WordPress Directory Size' ), 'value' => $size_directories['wordpress']['size'], + 'debug' => $size_directories['wordpress']['debug'], ), - array( + 'database_size' => array( 'label' => __( 'Database size' ), 'value' => size_format( $size_db, 2 ), ), - array( + 'total_size' => array( 'label' => __( 'Total installation size' ), - 'value' => $size_total, + 'value' => $size_total > 0 ? $size_total : __( 'Total size is not available. Some errors were encountered when determining the size of your installation.' ), + 'debug' => $size_total > 0 ? $size_total : 'not available', ), ); // Get a list of all drop-in replacements. - $dropins = get_dropins(); - $dropin_description = _get_dropins(); + $dropins = get_dropins(); + + // Get dropins descriptions. + $dropin_descriptions = _get_dropins(); + + // Spare few function calls. + $not_available = __( 'Not available' ); + foreach ( $dropins as $dropin_key => $dropin ) { - $info['wp-dropins']['fields'][ sanitize_key( $dropin_key ) ] = array( + $info['wp-dropins']['fields'][ sanitize_text_field( $dropin_key ) ] = array( 'label' => $dropin_key, - 'value' => $dropin_description[ $dropin_key ][0], + 'value' => $dropin_descriptions[ $dropin_key ][0], + 'debug' => 'true', ); } @@ -463,11 +559,13 @@ class WP_Debug_Data { } else { $imagick_version = __( 'Not available' ); } + $info['wp-media']['fields']['imagick_module_version'] = array( 'label' => __( 'ImageMagick version number' ), 'value' => ( is_array( $imagick_version ) ? $imagick_version['versionNumber'] : $imagick_version ), ); - $info['wp-media']['fields']['imagemagick_version'] = array( + + $info['wp-media']['fields']['imagemagick_version'] = array( 'label' => __( 'ImageMagick version string' ), 'value' => ( is_array( $imagick_version ) ? $imagick_version['versionString'] : $imagick_version ), ); @@ -475,17 +573,27 @@ class WP_Debug_Data { // If Imagick is used as our editor, provide some more information about its limitations. if ( 'WP_Image_Editor_Imagick' === _wp_image_editor_choose() && isset( $imagick ) && $imagick instanceof Imagick ) { $limits = array( - 'area' => ( defined( 'imagick::RESOURCETYPE_AREA' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_AREA ) ) : __( 'Not available' ) ), - 'disk' => ( defined( 'imagick::RESOURCETYPE_DISK' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_DISK ) : __( 'Not available' ) ), - 'file' => ( defined( 'imagick::RESOURCETYPE_FILE' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_FILE ) : __( 'Not available' ) ), - 'map' => ( defined( 'imagick::RESOURCETYPE_MAP' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_MAP ) ) : __( 'Not available' ) ), - 'memory' => ( defined( 'imagick::RESOURCETYPE_MEMORY' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_MEMORY ) ) : __( 'Not available' ) ), - 'thread' => ( defined( 'imagick::RESOURCETYPE_THREAD' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_THREAD ) : __( 'Not available' ) ), + 'area' => ( defined( 'imagick::RESOURCETYPE_AREA' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_AREA ) ) : $not_available ), + 'disk' => ( defined( 'imagick::RESOURCETYPE_DISK' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_DISK ) : $not_available ), + 'file' => ( defined( 'imagick::RESOURCETYPE_FILE' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_FILE ) : $not_available ), + 'map' => ( defined( 'imagick::RESOURCETYPE_MAP' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_MAP ) ) : $not_available ), + 'memory' => ( defined( 'imagick::RESOURCETYPE_MEMORY' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_MEMORY ) ) : $not_available ), + 'thread' => ( defined( 'imagick::RESOURCETYPE_THREAD' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_THREAD ) : $not_available ), + ); + + $limits_debug = array( + 'imagick::RESOURCETYPE_AREA' => ( defined( 'imagick::RESOURCETYPE_AREA' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_AREA ) ) : 'not available' ), + 'imagick::RESOURCETYPE_DISK' => ( defined( 'imagick::RESOURCETYPE_DISK' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_DISK ) : 'not available' ), + 'imagick::RESOURCETYPE_FILE' => ( defined( 'imagick::RESOURCETYPE_FILE' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_FILE ) : 'not available' ), + 'imagick::RESOURCETYPE_MAP' => ( defined( 'imagick::RESOURCETYPE_MAP' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_MAP ) ) : 'not available' ), + 'imagick::RESOURCETYPE_MEMORY' => ( defined( 'imagick::RESOURCETYPE_MEMORY' ) ? size_format( $imagick->getResourceLimit( imagick::RESOURCETYPE_MEMORY ) ) : 'not available' ), + 'imagick::RESOURCETYPE_THREAD' => ( defined( 'imagick::RESOURCETYPE_THREAD' ) ? $imagick->getResourceLimit( imagick::RESOURCETYPE_THREAD ) : 'not available' ), ); $info['wp-media']['fields']['imagick_limits'] = array( 'label' => __( 'Imagick Resource Limits' ), 'value' => $limits, + 'debug' => $limits_debug, ); } @@ -495,44 +603,85 @@ class WP_Debug_Data { } else { $gd = false; } + $info['wp-media']['fields']['gd_version'] = array( 'label' => __( 'GD version' ), - 'value' => ( is_array( $gd ) ? $gd['GD Version'] : __( 'Not available' ) ), + 'value' => ( is_array( $gd ) ? $gd['GD Version'] : $not_available ), + 'debug' => ( is_array( $gd ) ? $gd['GD Version'] : 'not available' ), ); // Get Ghostscript information, if available. if ( function_exists( 'exec' ) ) { $gs = exec( 'gs --version' ); - $gs = ( ! empty( $gs ) ? $gs : __( 'Not available' ) ); + + if ( empty( $gs ) ) { + $gs = $not_available; + $gs_debug = 'not available'; + } else { + $gs_debug = $gs; + } } else { - $gs = __( 'Unable to determine if Ghostscript is installed' ); + $gs = __( 'Unable to determine if Ghostscript is installed' ); + $gs_debug = 'unknown'; } + $info['wp-media']['fields']['ghostscript_version'] = array( 'label' => __( 'Ghostscript version' ), 'value' => $gs, + 'debug' => $gs_debug, ); // Populate the server debug fields. + if ( function_exists( 'php_uname' ) ) { + $server_architecture = sprintf( '%s %s %s', php_uname( 's' ), php_uname( 'r' ), php_uname( 'm' ) ); + } else { + $server_architecture = 'unknown'; + } + + if ( function_exists( 'phpversion' ) ) { + $php_version_debug = phpversion(); + // Whether PHP supports 64bit + $php64bit = ( PHP_INT_SIZE * 8 === 64 ); + + $php_version = sprintf( + '%s %s', + $php_version_debug, + ( $php64bit ? __( '(Supports 64bit values)' ) : __( '(Does not support 64bit values)' ) ) + ); + + if ( $php64bit ) { + $php_version_debug .= ' 64bit'; + } + } else { + $php_version = __( 'Unable to determine PHP version' ); + $php_version_debug = 'unknown'; + } + + if ( function_exists( 'php_sapi_name' ) ) { + $php_sapi = php_sapi_name(); + } else { + $php_sapi = 'unknown'; + } + $info['wp-server']['fields']['server_architecture'] = array( 'label' => __( 'Server architecture' ), - 'value' => ( ! function_exists( 'php_uname' ) ? __( 'Unable to determine server architecture' ) : sprintf( '%s %s %s', php_uname( 's' ), php_uname( 'r' ), php_uname( 'm' ) ) ), + 'value' => ( 'unknown' !== $server_architecture ? $server_architecture : __( 'Unable to determine server architecture' ) ), + 'debug' => $server_architecture, ); $info['wp-server']['fields']['httpd_software'] = array( 'label' => __( 'Web server' ), 'value' => ( isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : __( 'Unable to determine what web server software is used' ) ), + 'debug' => ( isset( $_SERVER['SERVER_SOFTWARE'] ) ? $_SERVER['SERVER_SOFTWARE'] : 'unknown' ), ); $info['wp-server']['fields']['php_version'] = array( 'label' => __( 'PHP version' ), - 'value' => ( ! function_exists( 'phpversion' ) ? __( 'Unable to determine PHP version' ) : sprintf( - '%s %s', - phpversion(), - ( 64 === PHP_INT_SIZE * 8 ? __( '(Supports 64bit values)' ) : __( '(Does not support 64bit values)' ) ) - ) - ), + 'value' => $php_version, + 'debug' => $php_version_debug, ); $info['wp-server']['fields']['php_sapi'] = array( 'label' => __( 'PHP SAPI' ), - 'value' => ( ! function_exists( 'php_sapi_name' ) ? __( 'Unable to determine PHP SAPI' ) : php_sapi_name() ), + 'value' => ( 'unknown' !== $php_sapi ? $php_sapi : __( 'Unable to determine PHP SAPI' ) ), + 'debug' => $php_sapi, ); // Some servers disable `ini_set()` and `ini_get()`, we check this before trying to get configuration values. @@ -540,6 +689,7 @@ class WP_Debug_Data { $info['wp-server']['fields']['ini_get'] = array( 'label' => __( 'Server settings' ), 'value' => __( 'Unable to determine some settings, as the ini_get() function has been disabled.' ), + 'debug' => 'ini_get() is disabled', ); } else { $info['wp-server']['fields']['max_input_variables'] = array( @@ -578,18 +728,27 @@ class WP_Debug_Data { } else { $info['wp-server']['fields']['curl_version'] = array( 'label' => __( 'cURL version' ), - 'value' => __( 'Not available' ), + 'value' => $not_available, + 'debug' => 'not available', ); } + // SUHOSIN + $suhosin_loaded = ( extension_loaded( 'suhosin' ) || ( defined( 'SUHOSIN_PATCH' ) && constant( 'SUHOSIN_PATCH' ) ) ); + $info['wp-server']['fields']['suhosin'] = array( 'label' => __( 'Is SUHOSIN installed?' ), - 'value' => ( ( extension_loaded( 'suhosin' ) || ( defined( 'SUHOSIN_PATCH' ) && constant( 'SUHOSIN_PATCH' ) ) ) ? __( 'Yes' ) : __( 'No' ) ), + 'value' => ( $suhosin_loaded ? __( 'Yes' ) : __( 'No' ) ), + 'debug' => $suhosin_loaded, ); + // Imagick + $imagick_loaded = extension_loaded( 'imagick' ); + $info['wp-server']['fields']['imagick_availability'] = array( 'label' => __( 'Is the Imagick library available?' ), - 'value' => ( extension_loaded( 'imagick' ) ? __( 'Yes' ) : __( 'No' ) ), + 'value' => ( $imagick_loaded ? __( 'Yes' ) : __( 'No' ) ), + 'debug' => $imagick_loaded, ); // Check if a .htaccess file exists. @@ -599,10 +758,12 @@ class WP_Debug_Data { // Filter away the core WordPress rules. $filtered_htaccess_content = trim( preg_replace( '/\# BEGIN WordPress[\s\S]+?# END WordPress/si', '', $htaccess_content ) ); + $filtered_htaccess_content = ! empty( $filtered_htaccess_content ); $info['wp-server']['fields']['htaccess_extra_rules'] = array( 'label' => __( 'htaccess rules' ), - 'value' => ( ! empty( $filtered_htaccess_content ) ? __( 'Custom rules have been added to your htaccess file.' ) : __( 'Your htaccess file contains only core WordPress features.' ) ), + 'value' => ( $filtered_htaccess_content ? __( 'Custom rules have been added to your htaccess file.' ) : __( 'Your htaccess file contains only core WordPress features.' ) ), + 'debug' => $filtered_htaccess_content, ); } @@ -646,33 +807,39 @@ class WP_Debug_Data { } } - $info['wp-database']['fields']['extension'] = array( + $info['wp-database']['fields']['extension'] = array( 'label' => __( 'Extension' ), 'value' => $extension, ); - $info['wp-database']['fields']['server_version'] = array( + + $info['wp-database']['fields']['server_version'] = array( 'label' => __( 'Server version' ), 'value' => $server, ); - $info['wp-database']['fields']['client_version'] = array( + + $info['wp-database']['fields']['client_version'] = array( 'label' => __( 'Client version' ), 'value' => $client_version, ); - $info['wp-database']['fields']['database_user'] = array( + + $info['wp-database']['fields']['database_user'] = array( 'label' => __( 'Database user' ), 'value' => $wpdb->dbuser, 'private' => true, ); - $info['wp-database']['fields']['database_host'] = array( + + $info['wp-database']['fields']['database_host'] = array( 'label' => __( 'Database host' ), 'value' => $wpdb->dbhost, 'private' => true, ); - $info['wp-database']['fields']['database_name'] = array( + + $info['wp-database']['fields']['database_name'] = array( 'label' => __( 'Database name' ), 'value' => $wpdb->dbname, 'private' => true, ); + $info['wp-database']['fields']['database_prefix'] = array( 'label' => __( 'Database prefix' ), 'value' => $wpdb->prefix, @@ -686,24 +853,31 @@ class WP_Debug_Data { $plugin_version = $plugin['Version']; $plugin_author = $plugin['Author']; - $plugin_version_string = __( 'No version or author information is available.' ); + $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 ); - } - if ( empty( $plugin_version ) && ! empty( $plugin_author ) ) { - // translators: %s: Plugin author name. - $plugin_version_string = sprintf( __( 'By %s' ), $plugin_author ); - } - if ( ! empty( $plugin_version ) && empty( $plugin_author ) ) { - // translators: %s: Plugin version number. - $plugin_version_string = sprintf( __( 'Version %s' ), $plugin_version ); + $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 ); + } } - $info['wp-mu-plugins']['fields'][ sanitize_key( $plugin['Name'] ) ] = array( + $info['wp-mu-plugins']['fields'][ sanitize_text_field( $plugin['Name'] ) ] = array( 'label' => $plugin['Name'], 'value' => $plugin_version_string, + 'debug' => $plugin_version_string_debug, ); } @@ -717,37 +891,44 @@ class WP_Debug_Data { $plugin_version = $plugin['Version']; $plugin_author = $plugin['Author']; - $plugin_version_string = __( 'No version or author information is available.' ); + $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 ); - } - if ( empty( $plugin_version ) && ! empty( $plugin_author ) ) { - // translators: %s: Plugin author name. - $plugin_version_string = sprintf( __( 'By %s' ), $plugin_author ); - } - if ( ! empty( $plugin_version ) && empty( $plugin_author ) ) { - // translators: %s: Plugin version number. - $plugin_version_string = sprintf( __( 'Version %s' ), $plugin_version ); + $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_update_needed = ' ' . sprintf( __( '(Latest version: %s)' ), $plugin_updates[ $plugin_path ]->update->new_version ); - } else { - $plugin_update_needed = ''; + $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 ); } - $info[ $plugin_part ]['fields'][ sanitize_key( $plugin['Name'] ) ] = array( + $info[ $plugin_part ]['fields'][ sanitize_text_field( $plugin['Name'] ) ] = array( 'label' => $plugin['Name'], - 'value' => $plugin_version_string . $plugin_update_needed, + 'value' => $plugin_version_string, + 'debug' => $plugin_version_string_debug, ); } // Populate the section for the currently active theme. global $_wp_theme_features; $theme_features = array(); + if ( ! empty( $_wp_theme_features ) ) { foreach ( $_wp_theme_features as $feature => $options ) { $theme_features[] = $feature; @@ -757,13 +938,20 @@ class WP_Debug_Data { $active_theme = wp_get_theme(); $theme_updates = get_theme_updates(); + // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $active_theme_version = $active_theme->Version; + $active_theme_version_debug = $active_theme_version; + if ( array_key_exists( $active_theme->stylesheet, $theme_updates ) ) { + $theme_update_new_version = $theme_updates[ $active_theme->stylesheet ]->update['new_version']; + // translators: %s: Latest theme version number. - $theme_update_needed_active = ' ' . sprintf( __( '(Latest version: %s)' ), $theme_updates[ $active_theme->stylesheet ]->update['new_version'] ); - } else { - $theme_update_needed_active = ''; + $active_theme_version .= ' ' . sprintf( __( '(Latest version: %s)' ), $theme_update_new_version ); + $active_theme_version_debug .= sprintf( ' (latest version: %s)', $theme_update_new_version ); } + $active_theme_author_uri = $active_theme->offsetGet( 'Author URI' ); + $info['wp-active-theme']['fields'] = array( 'name' => array( 'label' => __( 'Name' ), @@ -772,8 +960,8 @@ class WP_Debug_Data { ), 'version' => array( 'label' => __( 'Version' ), - // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase - 'value' => $active_theme->Version . $theme_update_needed_active, + 'value' => $active_theme_version, + 'debug' => $active_theme_version_debug, ), 'author' => array( 'label' => __( 'Author' ), @@ -782,11 +970,13 @@ class WP_Debug_Data { ), 'author_website' => array( 'label' => __( 'Author website' ), - 'value' => ( $active_theme->offsetGet( 'Author URI' ) ? $active_theme->offsetGet( 'Author URI' ) : __( 'Undefined' ) ), + 'value' => ( $active_theme_author_uri ? $active_theme_author_uri : __( 'Undefined' ) ), + 'debug' => ( $active_theme_author_uri ? $active_theme_author_uri : '(undefined)' ), ), 'parent_theme' => array( 'label' => __( 'Parent theme' ), 'value' => ( $active_theme->parent_theme ? $active_theme->parent_theme : __( 'None' ) ), + 'debug' => ( $active_theme->parent_theme ? $active_theme->parent_theme : 'none' ), ), 'theme_features' => array( 'label' => __( 'Theme features' ), @@ -799,7 +989,7 @@ class WP_Debug_Data { foreach ( $all_themes as $theme_slug => $theme ) { // Ignore the currently active theme from the list of all themes. - if ( $active_theme->stylesheet == $theme_slug ) { + if ( $active_theme->stylesheet === $theme_slug ) { continue; } // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase @@ -807,29 +997,38 @@ class WP_Debug_Data { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $theme_author = $theme->Author; - $theme_version_string = __( 'No version or author information is available.' ); + // Sanitize + $theme_author = wp_kses( $theme_author, array() ); + + $theme_version_string = __( 'No version or author information is available.' ); + $theme_version_string_debug = 'undefined'; if ( ! empty( $theme_version ) && ! empty( $theme_author ) ) { // translators: 1: Theme version number. 2: Theme author name. - $theme_version_string = sprintf( __( 'Version %1$s by %2$s' ), $theme_version, wp_kses( $theme_author, array() ) ); - } - if ( empty( $theme_version ) && ! empty( $theme_author ) ) { - // translators: %s: Theme author name. - $theme_version_string = sprintf( __( 'By %s' ), wp_kses( $theme_author, array() ) ); - } - if ( ! empty( $theme_version ) && empty( $theme_author ) ) { - // translators: %s: Theme version number. - $theme_version_string = sprintf( __( 'Version %s' ), $theme_version ); + $theme_version_string = sprintf( __( 'Version %1$s by %2$s' ), $theme_version, $theme_author ); + $theme_version_string_debug = sprintf( 'version: %s, author: %s', $theme_version, $theme_author ); + } else { + if ( ! empty( $theme_author ) ) { + // translators: %s: Theme author name. + $theme_version_string = sprintf( __( 'By %s' ), $theme_author ); + $theme_version_string_debug = sprintf( 'author: %s, version: (undefined)', $theme_author ); + } + + if ( ! empty( $theme_version ) ) { + // translators: %s: Theme version number. + $theme_version_string = sprintf( __( 'Version %s' ), $theme_version ); + $theme_version_string_debug = sprintf( 'author: (undefined), version: %s', $theme_version ); + } } if ( array_key_exists( $theme_slug, $theme_updates ) ) { // translators: %s: Latest theme version number. - $theme_update_needed = ' ' . sprintf( __( '(Latest version: %s)' ), $theme_updates[ $theme_slug ]->update['new_version'] ); - } else { - $theme_update_needed = ''; + $theme_version_string .= ' ' . sprintf( __( '(Latest version: %s)' ), $theme_updates[ $theme_slug ]->update['new_version'] ); + $theme_version_string_debug .= sprintf( ' (latest version: %s)', $theme_updates[ $theme_slug ]->update['new_version'] ); } - $info['wp-themes']['fields'][ sanitize_key( $theme->Name ) ] = array( + // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $info['wp-themes']['fields'][ sanitize_text_field( $theme->Name ) ] = array( 'label' => sprintf( // translators: 1: Theme name. 2: Theme slug. __( '%1$s (%2$s)' ), @@ -837,58 +1036,64 @@ class WP_Debug_Data { $theme->Name, $theme_slug ), - 'value' => $theme_version_string . $theme_update_needed, + 'value' => $theme_version_string, + 'debug' => $theme_version_string_debug, ); } // Add more filesystem checks if ( defined( 'WPMU_PLUGIN_DIR' ) && is_dir( WPMU_PLUGIN_DIR ) ) { - $info['wp-filesystem']['fields']['mu_plugin_directory'] = array( + $is_writable_wpmu_plugin_dir = wp_is_writable( WPMU_PLUGIN_DIR ); + + $info['wp-filesystem']['fields']['mu-plugins'] = array( 'label' => __( 'The must use plugins directory' ), - 'value' => ( wp_is_writable( WPMU_PLUGIN_DIR ) ? __( 'Writable' ) : __( 'Not writable' ) ), + 'value' => ( $is_writable_wpmu_plugin_dir ? __( 'Writable' ) : __( 'Not writable' ) ), + 'debug' => ( $is_writable_wpmu_plugin_dir ? 'writable' : 'not writable' ), ); } /** - * Add or modify new debug sections. + * Add or modify the debug information. * - * Plugin or themes may wish to introduce their own debug information without creating additional admin pages for this - * kind of information as it is rarely needed, they can then utilize this filter to introduce their own sections. + * Plugin or themes may wish to introduce their own debug information without creating additional admin pages + * they can utilize this filter to introduce their own sections or add more data to existing sections. * - * Array keys added by core are all prefixed with `wp-`, plugins and themes are encouraged to use their own slug as - * a prefix, both for consistency as well as avoiding key collisions. + * Array keys for sections added by core are all prefixed with `wp-`, plugins and themes should use their own slug as + * a prefix, both for consistency as well as avoiding key collisions. Note that the array keys are used as labels + * for the copied data. * * @since 5.2.0 * * @param array $args { * The debug information to be added to the core information page. * + * This is an associative multi-dimensional array, up to three levels deep. The topmost array holds the sections. + * Each section has a `$fields` associative array (see below), and each `$value` in `$fields` can be + * another associative array of name/value pairs when there is more structured data to display. + * * @type string $label The title for this section of the debug output. * @type string $description Optional. A description for your information section which may contain basic HTML * markup: `em`, `strong` and `a` for linking to documentation or putting emphasis. * @type boolean $show_count Optional. If set to `true` the amount of fields will be included in the title for * this section. * @type boolean $private Optional. If set to `true` the section and all associated fields will be excluded - * from the copy-paste text area. + * from the copied data. * @type array $fields { * An associative array containing the data to be displayed. * * @type string $label The label for this piece of information. - * @type string $value The output that is of interest for this field. - * @type boolean $private Optional. If set to `true` the field will not be included in the copy-paste text area - * on top of the page, allowing you to show, for example, API keys here. + * @type string $value The output that is displayed for this field. Text should be translated. Can be + * an associative array that is displayed as name/value pairs. + * @type string $debug Optional. The output that is used for this field when the user copies the data. + * It should be more concise and not translated. If not set, the content of `$value` is used. + * Note that the array keys are used as labels for the copied data. + * @type boolean $private Optional. If set to `true` the field will not be included in the copied data + * allowing you to show, for example, API keys here. * } * } */ $info = apply_filters( 'debug_information', $info ); - if ( ! empty( $locale ) ) { - // Change the language used for translations - if ( $switched_locale ) { - restore_previous_locale(); - } - } - return $info; } @@ -898,10 +1103,10 @@ class WP_Debug_Data { * @since 5.2.0 * * @param array $info_array Information gathered from the `WP_Debug_Data::debug_data` function. - * @param string $type Optional. The data type to format the information as. Default 'text'. + * @param string $type The data type to return, either 'info' or 'debug'. * @return string The formatted data. */ - public static function format( $info_array, $type = 'text' ) { + public static function format( $info_array, $type ) { $return = "`\n"; foreach ( $info_array as $section => $details ) { @@ -910,36 +1115,49 @@ class WP_Debug_Data { continue; } + $section_label = 'debug' === $type ? $section : $details['label']; + $return .= sprintf( "### %s%s ###\n\n", - $details['label'], + $section_label, ( isset( $details['show_count'] ) && $details['show_count'] ? sprintf( ' (%d)', count( $details['fields'] ) ) : '' ) ); - foreach ( $details['fields'] as $field ) { + foreach ( $details['fields'] as $field_name => $field ) { if ( isset( $field['private'] ) && true === $field['private'] ) { continue; } - $values = $field['value']; - if ( is_array( $field['value'] ) ) { - $values = ''; - - foreach ( $field['value'] as $name => $value ) { - $values .= sprintf( - "\n\t%s: %s", - $name, - $value - ); - } + if ( 'debug' === $type && isset( $field['debug'] ) ) { + $debug_data = $field['debug']; + } else { + $debug_data = $field['value']; } - $return .= sprintf( - "%s: %s\n", - $field['label'], - $values - ); + // Can be array, one level deep only. + if ( is_array( $debug_data ) ) { + $value = ''; + + foreach ( $field['value'] as $name => $value ) { + $value .= sprintf( "\n\t%s: %s", $name, $value ); + } + } elseif ( is_bool( $debug_data ) ) { + $value = $debug_data ? 'true' : 'false'; + } elseif ( empty( $debug_data ) && '0' !== $debug_data ) { + $value = 'undefined'; + } else { + $value = $debug_data; + } + + if ( 'debug' === $type ) { + $label = $field_name; + } else { + $label = $field['label']; + } + + $return .= sprintf( "%s: %s\n", $label, $value ); } + $return .= "\n"; } diff --git a/wp-admin/site-health-info.php b/wp-admin/site-health-info.php index 771fad8763..08bf002fbb 100644 --- a/wp-admin/site-health-info.php +++ b/wp-admin/site-health-info.php @@ -66,11 +66,8 @@ require_once( ABSPATH . 'wp-admin/admin-header.php' );