Changeset 58830 for trunk/src/wp-admin/includes/class-wp-debug-data.php

Timestamp:

07/29/2024 06:20:11 PM (2 months ago)

Author:

dmsnell

Message:

WP_Debug_Data: Extract wp-filesystem data into separate method.

This is the first 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 first of twelve groups, the wp-filesystem 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/7065
Discussed in https://core.trac.wordpress.org/ticket/61648

Props: afragen, apermo, costdev, dmsnell.
See #61648.

File:

• trunk/src/wp-admin/includes/class-wp-debug-data.php (modified) (3 diffs)

trunk/src/wp-admin/includes/class-wp-debug-data.php

@@ -339 +339 @@
                     'value' => ( defined( 'DB_COLLATE' ) ? DB_COLLATE : __( 'Undefined' ) ),
                     'debug' => ( defined( 'DB_COLLATE' ) ? DB_COLLATE : 'undefined' ),
-                ),
-            ),
-        );
-
-        $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_theme_root( get_template() ) );
-        $is_writable_fonts_dir          = wp_is_writable( wp_get_font_dir()['basedir'] );
-
-        $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' ),
-                ),
-                'fonts'      => array(
-                    'label' => __( 'The fonts directory' ),
-                    'value' => ( $is_writable_fonts_dir ? __( 'Writable' ) : __( 'Not writable' ) ),
-                    'debug' => ( $is_writable_fonts_dir ? 'writable' : 'not writable' ),
                 ),
             ),
@@ -1414 +1370 @@
         }
 
-        // Add more filesystem checks.
-        if ( defined( 'WPMU_PLUGIN_DIR' ) && is_dir( WPMU_PLUGIN_DIR ) ) {
-            $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' => ( $is_writable_wpmu_plugin_dir ? __( 'Writable' ) : __( 'Not writable' ) ),
-                'debug' => ( $is_writable_wpmu_plugin_dir ? 'writable' : 'not writable' ),
-            );
-        }
+        $info['wp-filesystem'] = self::get_wp_filesystem();
 
         /**
@@ -1491 +1438 @@
 
     /**
+     * Gets the file system section of the debug data.
+     *
+     * @since 6.7.0
+     *
+     * @return array
+     */
+    private static function get_wp_filesystem(): array {
+        $upload_dir                     = wp_upload_dir();
+        $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_theme_root( get_template() ) );
+        $is_writable_fonts_dir          = wp_is_writable( wp_get_font_dir()['basedir'] );
+
+        $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' ),
+            ),
+            'fonts'      => array(
+                'label' => __( 'The fonts directory' ),
+                'value' => ( $is_writable_fonts_dir ? __( 'Writable' ) : __( 'Not writable' ) ),
+                'debug' => ( $is_writable_fonts_dir ? 'writable' : 'not writable' ),
+            ),
+        );
+
+        // Add more filesystem checks.
+        if ( defined( 'WPMU_PLUGIN_DIR' ) && is_dir( WPMU_PLUGIN_DIR ) ) {
+            $is_writable_wpmu_plugin_dir = wp_is_writable( WPMU_PLUGIN_DIR );
+
+            $fields['mu-plugins'] = array(
+                'label' => __( 'The must use plugins directory' ),
+                'value' => ( $is_writable_wpmu_plugin_dir ? __( 'Writable' ) : __( 'Not writable' ) ),
+                'debug' => ( $is_writable_wpmu_plugin_dir ? 'writable' : 'not writable' ),
+            );
+        }
+
+        return array(
+            'label'       => __( 'Filesystem Permissions' ),
+            'description' => __( 'Shows whether WordPress is able to write to the directories it needs access to.' ),
+            'fields'      => $fields,
+        );
+    }
+
+    /**
      * Returns the value of a MySQL system variable.
      *