Add Site Health test for Object Caching

plugins/performance-lab/includes/site-health/load.php

@@ -25,3 +25,7 @@
 // AVIF Support site health check.
 require_once __DIR__ . '/avif-support/helper.php';
 require_once __DIR__ . '/avif-support/hooks.php';
+
+// Object Cache Support site health info.
+require_once __DIR__ . '/object-cache/helper.php';
+require_once __DIR__ . '/object-cache/hooks.php';

plugins/performance-lab/includes/site-health/object-cache/helper.php

@@ -0,0 +1,127 @@
+<?php
+/**
+ * Helper functions used for Object Cache Support Info.
+ *
+ * @package performance-lab
+ * @since n.e.x.t
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+/**
+ * Callback for Object Cache Info fields.
+ *
+ * @return array<string, array{label: string, value: string}> Fields.
+ * @since n.e.x.t
+ */
+function perflab_object_cache_supported_fields(): array {
+	return array(
+		'extension'        => array(
+			'label' => __( 'Extension', 'performance-lab' ),
+			'value' => perflab_get_cache_type(),
+		),
+		'multiple_gets'    => array(
+			'label' => __( 'Multiple gets', 'performance-lab' ),
+			'value' => wp_cache_supports( 'get_multiple' ) ? __( 'Enabled', 'performance-lab' ) : __( 'Disabled', 'performance-lab' ),
+		),
+		'multiple_sets'    => array(
+			'label' => __( 'Multiple sets', 'performance-lab' ),
+			'value' => wp_cache_supports( 'set_multiple' ) ? __( 'Enabled', 'performance-lab' ) : __( 'Disabled', 'performance-lab' ),
+		),
+		'multiple_deletes' => array(
+			'label' => __( 'Multiple deletes', 'performance-lab' ),
+			'value' => wp_cache_supports( 'delete_multiple' ) ? __( 'Enabled', 'performance-lab' ) : __( 'Disabled', 'performance-lab' ),
+		),
+		'flush_group'      => array(
+			'label' => __( 'Flush group', 'performance-lab' ),
+			'value' => wp_cache_supports( 'flush_group' ) ? __( 'Enabled', 'performance-lab' ) : __( 'Disabled', 'performance-lab' ),
+		),
+	);
+}
+
+/**
+ * Attempts to determine which object cache is being used as in wp-cli repository.
+ *
+ * Note that the guesses made by this function are based on the WP_Object_Cache classes
+ * that define the 3rd party object cache extension. Changes to those classes could render
+ * problems with this function's ability to determine which object cache is being used.
+ *
+ * This function was copied from WP-CLI.
+ *
+ * @link https://github.com/wp-cli/wp-cli/blob/0ca6d920123ac904c918d69181edc5071dc92c9d/php/utils-wp.php#L259-L331.
+ *
+ * @global bool $_wp_using_ext_object_cache Whether external object cache is being used.
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @return string Object cache type.
+ * @since n.e.x.t
+ */
+function perflab_get_cache_type(): string {
+	global $_wp_using_ext_object_cache, $wp_object_cache;
+
+	$message = '';
+
+	if ( ! empty( $_wp_using_ext_object_cache ) ) {
+		// Test for Memcached PECL extension memcached object cache (https://github.com/tollmanz/wordpress-memcached-backend).
+		if ( isset( $wp_object_cache->m ) && $wp_object_cache->m instanceof \Memcached ) {
+			$message = 'Memcached';
+
+			// Test for Memcache PECL extension memcached object cache (https://wordpress.org/extend/plugins/memcached/).
+		} elseif ( isset( $wp_object_cache->mc ) ) {
+			$is_memcache = true;
+			foreach ( $wp_object_cache->mc as $bucket ) {
+				if ( ! $bucket instanceof \Memcache && ! $bucket instanceof \Memcached ) {
+					$is_memcache = false;
+				}
+			}
+
+			if ( $is_memcache ) {
+				$message = 'Memcache';
+			}
+
+			// Test for Xcache object cache (https://plugins.svn.wordpress.org/xcache/trunk/object-cache.php).
+		} elseif ( $wp_object_cache instanceof \XCache_Object_Cache ) { // @phpstan-ignore-line
+			$message = 'Xcache';
+
+			// Test for WinCache object cache (https://wordpress.org/extend/plugins/wincache-object-cache-backend/).
+		} elseif ( class_exists( 'WinCache_Object_Cache' ) ) {
+			$message = 'WinCache';
+
+			// Test for APC object cache (https://wordpress.org/extend/plugins/apc/).
+		} elseif ( class_exists( 'APC_Object_Cache' ) ) {
+			$message = 'APC';
+
+			// Test for WP Redis (https://wordpress.org/plugins/wp-redis/).
+		} elseif ( isset( $wp_object_cache->redis ) && $wp_object_cache->redis instanceof \Redis ) {
+			$message = 'Redis';
+
+			// Test for Redis Object Cache (https://wordpress.org/plugins/redis-cache/).
+		} elseif ( method_exists( $wp_object_cache, 'redis_instance' ) && method_exists( $wp_object_cache, 'redis_status' ) ) {
+			$message = 'Redis';
+
+			// Test for Object Cache Pro (https://objectcache.pro/).
+		} elseif ( method_exists( $wp_object_cache, 'config' ) && method_exists( $wp_object_cache, 'connection' ) ) {
+			$message = 'Redis';
+
+			// Test for WP LCache Object cache (https://github.com/lcache/wp-lcache).
+		} elseif ( isset( $wp_object_cache->lcache ) && $wp_object_cache->lcache instanceof \LCache\Integrated ) { // @phpstan-ignore-line
+			$message = 'WP LCache';
+
+		} elseif ( function_exists( 'w3_instance' ) ) {
+			$config  = w3_instance( 'W3_Config' );
+			$message = 'Unknown';
+
+			if ( $config->get_boolean( 'objectcache.enabled' ) ) {
+				$message = 'W3TC ' . $config->get_string( 'objectcache.engine' );
+			}
+		} else {
+			$message = 'Unknown';
+		}
+	} else {
+		$message = 'Disabled';
+	}
+
+	return $message;
+}

plugins/performance-lab/includes/site-health/object-cache/hooks.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * Hook callbacks used for Site Health Info.
+ *
+ * @package performance-lab
+ * @since n.e.x.t
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+/**
+ * Adds Object Cache module to Site Health Info.
+ *
+ * @param array{object_cache: array{label: string,description: string,fields: array<string, array{label: string,value: string}>}} $info Site Health Info.
+ *
+ * @return array{object_cache: array{label: string,description: string,fields: array<string, array{label: string,value: string}>}} Amended Info.
+ * @since n.e.x.t
+ */
+function perflab_object_cache_supported_info( array $info ): array {
+	$info['object_cache'] = array(
+		'label'       => __( 'Object Caching', 'performance-lab' ),
+		'description' => __( 'Shows which features object cache supports and if object caching is in use.', 'performance-lab' ),
+		'fields'      => perflab_object_cache_supported_fields(),
+	);
+
+	return $info;
+}
+
+add_filter( 'debug_information', 'perflab_object_cache_supported_info', 10, 1 );