feat: Introduce 'wp_ai_client_cache_group' filter hook

Author: Sandip Baikare

src/wp-includes/ai-client/adapters/class-wp-ai-client-cache.php

@@ -29,6 +29,27 @@ class WP_AI_Client_Cache implements CacheInterface {
 	 */
 	private const CACHE_GROUP = 'wp_ai_client';
 
+	/**
+	 * Retrieves the cache group used for cache operations, applying a filter for customization.
+	 *
+	 * @since 7.1.0
+	 *
+	 * @return string Cache group name.
+	 */
+	private function get_cache_group(): string {		
+		/**
+		 * Filter the cache group used by the WP AI Client cache adapter.
+		 *
+		 * Allows integrators to change the object cache group under which AI client
+		 * items are stored.
+		 *
+		 * @since 7.1.0
+		 *
+		 * @param string $group The cache group.
+		 */
+		return (string) apply_filters( 'wp_ai_client_cache_group', self::CACHE_GROUP );
+	}
+
 	/**
 	 * Fetches a value from the cache.
 	 *
@@ -40,7 +61,7 @@ class WP_AI_Client_Cache implements CacheInterface {
 	 */
 	public function get( $key, $default_value = null ) {
 		$found = false;
-		$value = wp_cache_get( $key, self::CACHE_GROUP, false, $found );
+		$value = wp_cache_get( $key, $this->get_cache_group(), false, $found );
 
 		if ( ! $found ) {
 			return $default_value;
@@ -62,7 +83,7 @@ public function get( $key, $default_value = null ) {
 	public function set( $key, $value, $ttl = null ): bool {
 		$expire = $this->ttl_to_seconds( $ttl );
 
-		return wp_cache_set( $key, $value, self::CACHE_GROUP, $expire );
+		return wp_cache_set( $key, $value, $this->get_cache_group(), $expire );
 	}
 
 	/**
@@ -74,7 +95,7 @@ public function set( $key, $value, $ttl = null ): bool {
 	 * @return bool True if the item was successfully removed. False if there was an error.
 	 */
 	public function delete( $key ): bool {
-		return wp_cache_delete( $key, self::CACHE_GROUP );
+		return wp_cache_delete( $key, $this->get_cache_group() );
 	}
 
 	/**
@@ -92,7 +113,7 @@ public function clear(): bool {
 			return false;
 		}
 
-		return wp_cache_flush_group( self::CACHE_GROUP );
+		return wp_cache_flush_group( $this->get_cache_group() );
 	}
 
 	/**
@@ -111,7 +132,7 @@ public function getMultiple( $keys, $default_value = null ): array {
 		 * @var array<string> $keys_array
 		 */
 		$keys_array = $this->iterable_to_array( $keys );
-		$values     = wp_cache_get_multiple( $keys_array, self::CACHE_GROUP );
+		$values     = wp_cache_get_multiple( $keys_array, $this->get_cache_group() );
 		$result     = array();
 
 		foreach ( $keys_array as $key ) {
@@ -138,7 +159,7 @@ public function getMultiple( $keys, $default_value = null ): array {
 	public function setMultiple( $values, $ttl = null ): bool {
 		$values_array = $this->iterable_to_array( $values );
 		$expire       = $this->ttl_to_seconds( $ttl );
-		$results      = wp_cache_set_multiple( $values_array, self::CACHE_GROUP, $expire );
+		$results      = wp_cache_set_multiple( $values_array, $this->get_cache_group(), $expire );
 
 		// Return true only if all operations succeeded.
 		return ! in_array( false, $results, true );
@@ -154,7 +175,7 @@ public function setMultiple( $values, $ttl = null ): bool {
 	 */
 	public function deleteMultiple( $keys ): bool {
 		$keys_array = $this->iterable_to_array( $keys );
-		$results    = wp_cache_delete_multiple( $keys_array, self::CACHE_GROUP );
+		$results    = wp_cache_delete_multiple( $keys_array, $this->get_cache_group() );
 
 		// Return true only if all operations succeeded.
 		return ! in_array( false, $results, true );
@@ -170,7 +191,7 @@ public function deleteMultiple( $keys ): bool {
 	 */
 	public function has( $key ): bool {
 		$found = false;
-		wp_cache_get( $key, self::CACHE_GROUP, false, $found );
+		wp_cache_get( $key, $this->get_cache_group(), false, $found );
 
 		return (bool) $found;
 	}

tests/phpunit/tests/ai-client/wpAiClientCache.php

@@ -218,4 +218,40 @@ public function test_ttl_with_date_interval() {
 		$this->assertTrue( $this->cache->set( 'key1', 'value1', $ttl ) );
 		$this->assertSame( 'value1', $this->cache->get( 'key1' ) );
 	}
+
+	/**
+	 * Test that the cache group filter is respected.
+	 *
+	 * @ticket 64591
+	 */
+	public function test_cache_group_filter_is_respected() {
+        add_filter( 'wp_ai_client_cache_group', function( $group ) {
+            return 'wp_ai_client_tests_group';
+        } );
+
+        $set = $this->cache->set( 'ai_test_key', 'ai_value', 3600 );
+        $this->assertTrue( $set );
+
+        // Directly read from the underlying object cache using the expected group.
+        $value = wp_cache_get( 'ai_test_key', 'wp_ai_client_tests_group' );
+        $this->assertSame( 'ai_value', $value );
+    }
+
+	/**
+	 * Test that a non-string cache group filter value is cast to string.
+	 * 
+	 * @ticket 64591
+	 */
+	public function test_cache_group_filter_returns_non_string() {
+		add_filter( 'wp_ai_client_cache_group', function( $group ) {
+			return 12345; // Non-string value.
+		} );
+		
+		$set = $this->cache->set( 'ai_test_key', 'ai_value', 3600 );
+		$this->assertTrue( $set );
+
+		// Directly read from the underlying object cache using the expected group (cast to string).
+		$value = wp_cache_get( 'ai_test_key', '12345' );
+		$this->assertSame( 'ai_value', $value );
+	}
 }