Changeset 61612

Timestamp:

02/11/2026 08:14:09 PM (7 weeks ago)

Author:

westonruter

Message:

Site Health: Add test and debug data for Opcode Cache.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/9260

Props rollybueno, westonruter, swissspidy, peterwilsoncc, szepeviktor, ozgursar, oglekler, johnbillion, ugyensupport, abcd95, shailu25, noruzzaman.
Fixes #63697.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-debug-data.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-site-health.php (modified) (3 diffs)
• tests/phpunit/tests/admin/wpSiteHealth.php (modified) (1 diff)

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

@@ -472 +472 @@
         );
 
+        // Opcode Cache.
+        if ( function_exists( 'opcache_get_status' ) ) {
+            $opcache_status = @opcache_get_status( false ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged -- Warning emitted in failure case.
+
+            if ( false === $opcache_status ) {
+                $fields['opcode_cache'] = array(
+                    'label' => __( 'Opcode cache' ),
+                    'value' => __( 'Disabled by configuration' ),
+                    'debug' => 'not available',
+                );
+            } else {
+                $fields['opcode_cache'] = array(
+                    'label' => __( 'Opcode cache' ),
+                    'value' => $opcache_status['opcache_enabled'] ? __( 'Enabled' ) : __( 'Disabled' ),
+                    'debug' => $opcache_status['opcache_enabled'],
+                );
+
+                if ( true === $opcache_status['opcache_enabled'] ) {
+                    $fields['opcode_cache_memory_usage'] = array(
+                        'label' => __( 'Opcode cache memory usage' ),
+                        'value' => sprintf(
+                            /* translators: 1: Used memory, 2: Total memory */
+                            __( '%1$s of %2$s' ),
+                            size_format( $opcache_status['memory_usage']['used_memory'] ),
+                            size_format( $opcache_status['memory_usage']['free_memory'] + $opcache_status['memory_usage']['used_memory'] )
+                        ),
+                        'debug' => sprintf(
+                            '%s of %s',
+                            $opcache_status['memory_usage']['used_memory'],
+                            $opcache_status['memory_usage']['free_memory'] + $opcache_status['memory_usage']['used_memory']
+                        ),
+                    );
+
+                    if ( 0 !== $opcache_status['interned_strings_usage']['buffer_size'] ) {
+                        $fields['opcode_cache_interned_strings_usage'] = array(
+                            'label' => __( 'Opcode cache interned strings usage' ),
+                            'value' => sprintf(
+                                /* translators: 1: Percentage used, 2: Total memory, 3: Free memory */
+                                __( '%1$s%% of %2$s (%3$s free)' ),
+                                number_format_i18n( ( $opcache_status['interned_strings_usage']['used_memory'] / $opcache_status['interned_strings_usage']['buffer_size'] ) * 100, 2 ),
+                                size_format( $opcache_status['interned_strings_usage']['buffer_size'] ),
+                                size_format( $opcache_status['interned_strings_usage']['free_memory'] )
+                            ),
+                            'debug' => sprintf(
+                                '%s%% of %s (%s free)',
+                                round( ( $opcache_status['interned_strings_usage']['used_memory'] / $opcache_status['interned_strings_usage']['buffer_size'] ) * 100, 2 ),
+                                $opcache_status['interned_strings_usage']['buffer_size'],
+                                $opcache_status['interned_strings_usage']['free_memory']
+                            ),
+                        );
+                    }
+
+                    $fields['opcode_cache_hit_rate'] = array(
+                        'label' => __( 'Opcode cache hit rate' ),
+                        'value' => sprintf(
+                            /* translators: %s: Hit rate percentage */
+                            __( '%s%%' ),
+                            number_format_i18n( $opcache_status['opcache_statistics']['opcache_hit_rate'], 2 )
+                        ),
+                        'debug' => round( $opcache_status['opcache_statistics']['opcache_hit_rate'], 2 ),
+                    );
+
+                    $fields['opcode_cache_full'] = array(
+                        'label' => __( 'Is the Opcode cache full?' ),
+                        'value' => $opcache_status['cache_full'] ? __( 'Yes' ) : __( 'No' ),
+                        'debug' => $opcache_status['cache_full'],
+                    );
+                }
+            }
+        } else {
+            $fields['opcode_cache'] = array(
+                'label' => __( 'Opcode cache' ),
+                'value' => __( 'Disabled' ),
+                'debug' => 'not available',
+            );
+        }
+
         // Pretty permalinks.
         $pretty_permalinks_supported = got_url_rewrite();

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -2751 +2751 @@
                 __( 'Your site is hidden from search engines. Consider enabling indexing if this is a public site.', 'default' )
             );
+        }
+
+        return $result;
+    }
+
+    /**
+     * Tests if opcode cache is enabled and available.
+     *
+     * @since 7.0.0
+     *
+     * @return array<string, string|array<string, string>> The test result.
+     */
+    public function get_test_opcode_cache(): array {
+        $opcode_cache_enabled = false;
+        if ( function_exists( 'opcache_get_status' ) ) {
+            $status = @opcache_get_status( false ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged -- Warning emitted in failure case.
+            if ( $status && true === $status['opcache_enabled'] ) {
+                $opcode_cache_enabled = true;
+            }
+        }
+
+        $result = array(
+            'label'       => __( 'Opcode cache is enabled' ),
+            'status'      => 'good',
+            'badge'       => array(
+                'label' => __( 'Performance' ),
+                'color' => 'blue',
+            ),
+            'description' => sprintf(
+                '<p>%s</p>',
+                __( 'Opcode cache improves PHP performance by storing precompiled script bytecode in memory, reducing the need for PHP to load and parse scripts on each request.' )
+            ),
+            'actions'     => sprintf(
+                '<p><a href="%s" target="_blank">%s<span class="screen-reader-text"> %s</span><span aria-hidden="true" class="dashicons dashicons-external"></span></a></p>',
+                esc_url( 'https://www.php.net/manual/en/book.opcache.php' ),
+                __( 'Learn more about OPcache.' ),
+                /* translators: Hidden accessibility text. */
+                __( '(opens in a new tab)' )
+            ),
+            'test'        => 'opcode_cache',
+        );
+
+        if ( ! $opcode_cache_enabled ) {
+            $result['status']       = 'recommended';
+            $result['label']        = __( 'Opcode cache is not enabled' );
+            $result['description'] .= '<p>' . __( 'Enabling this cache can significantly improve the performance of your site.' ) . '</p>';
         }
 
@@ -2848 +2894 @@
                     'test'  => 'search_engine_visibility',
                 ),
+                'opcode_cache'                 => array(
+                    'label' => __( 'Opcode cache' ),
+                    'test'  => 'opcode_cache',
+                ),
             ),
             'async'  => array(
@@ -3416 +3466 @@
 
             // Generic caching proxies (Nginx, Varnish, etc.)
-            'x-cache'           => $cache_hit_callback,
-            'x-cache-status'    => $cache_hit_callback,
-            'x-litespeed-cache' => $cache_hit_callback,
-            'x-proxy-cache'     => $cache_hit_callback,
-            'via'               => '',
+            'x-cache'                => $cache_hit_callback,
+            'x-cache-status'         => $cache_hit_callback,
+            'x-litespeed-cache'      => $cache_hit_callback,
+            'x-proxy-cache'          => $cache_hit_callback,
+            'via'                    => '',
 
             // Cloudflare
-            'cf-cache-status' => $cache_hit_callback,
+            'cf-cache-status'        => $cache_hit_callback,
         );
 

trunk/tests/phpunit/tests/admin/wpSiteHealth.php

@@ -573 +573 @@
         add_option( 'test_set_autoloaded_option', $heavy_option_string, '', true );
     }
+
+    /**
+     * Tests get_test_opcode_cache() return structure.
+     *
+     * @ticket 63697
+     *
+     * @covers ::get_test_opcode_cache()
+     */
+    public function test_get_test_opcode_cache_return_structure() {
+        $result = $this->instance->get_test_opcode_cache();
+
+        $this->assertIsArray( $result );
+        $this->assertArrayHasKey( 'label', $result );
+        $this->assertArrayHasKey( 'status', $result );
+        $this->assertArrayHasKey( 'badge', $result );
+        $this->assertArrayHasKey( 'description', $result );
+        $this->assertArrayHasKey( 'actions', $result );
+        $this->assertArrayHasKey( 'test', $result );
+
+        $this->assertSame( 'opcode_cache', $result['test'] );
+        $this->assertSame(
+            array(
+                'label' => __( 'Performance' ),
+                'color' => 'blue',
+            ),
+            $result['badge']
+        );
+        $this->assertContains( $result['status'], array( 'good', 'recommended' ), 'Status must be good or recommended.' );
+    }
+
+    /**
+     * Tests get_test_opcode_cache() result when opcode cache is enabled or not.
+     *
+     * Covers: opcache enabled, disabled, not available, and opcache_get_status() returns false.
+     *
+     * @ticket 63697
+     *
+     * @covers ::get_test_opcode_cache()
+     */
+    public function test_get_test_opcode_cache_result_by_environment() {
+        $result = $this->instance->get_test_opcode_cache();
+
+        $opcache_enabled = false;
+        if ( function_exists( 'opcache_get_status' ) ) {
+            $status = @opcache_get_status( false ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged -- Warning emitted in failure case.
+            if ( $status && true === $status['opcache_enabled'] ) {
+                $opcache_enabled = true;
+            }
+        }
+
+        if ( $opcache_enabled ) {
+            $this->assertSame( 'good', $result['status'], 'When opcache is enabled, status should be "good".' );
+            $this->assertSame( __( 'Opcode cache is enabled' ), $result['label'] );
+        } else {
+            $this->assertSame( 'recommended', $result['status'] );
+            $this->assertSame( __( 'Opcode cache is not enabled' ), $result['label'] );
+            $this->assertStringContainsString( __( 'Enabling this cache can significantly improve the performance of your site.' ), $result['description'] );
+        }
+    }
 }