Changeset 62557

Timestamp:

06/25/2026 09:08:14 AM (3 months ago)

Author:

gziolo

Message:

Allow customization of the AI Client object cache group

Introduces the wp_ai_client_cache_group filter to allow developers to customize the object cache group used by WP_AI_Client_Cache.

Includes tests for using a custom cache group and casting non-string filter values to strings.

Props baikaresandeep007-1, apermo.
Fixes #65127.

Location:

trunk

Files:

• src/wp-includes/ai-client/adapters/class-wp-ai-client-cache.php (modified) (9 diffs)
• tests/phpunit/tests/ai-client/wpAiClientCache.php (modified) (1 diff)

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

@@ -31 +31 @@
 
         /**
+         * 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 {
+                /**
+                 * Filters 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. This is useful for avoiding key collisions, creating
+                 * environment-specific caches, or adapting to backend constraints.
+                 *
+                 * @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.
          *
@@ -41 +63 @@
         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 ) {
@@ -63 +85 @@
                 $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 );
         }
 
@@ -75 +97 @@
          */
         public function delete( $key ): bool {
-                return wp_cache_delete( $key, self::CACHE_GROUP );
+                return wp_cache_delete( $key, $this->get_cache_group() );
         }
 
@@ -93 +115 @@
                 }
 
-                return wp_cache_flush_group( self::CACHE_GROUP );
+                return wp_cache_flush_group( $this->get_cache_group() );
         }
 
@@ -112 +134 @@
                  */
                 $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();
 
@@ -139 +161 @@
                 $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.
@@ -155 +177 @@
         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.
@@ -171 +193 @@
         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;

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

@@ -219 +219 @@
                 $this->assertSame( 'value1', $this->cache->get( 'key1' ) );
         }
+
+        /**
+         * Test that the cache group filter is respected.
+         *
+         * @ticket 65127
+         */
+        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 );
+
+                $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 65127
+         */
+        public function test_cache_group_filter_returns_non_string() {
+                add_filter(
+                        'wp_ai_client_cache_group',
+                        function ( $group ) {
+                                return 12345;
+                        }
+                );
+
+                $set = $this->cache->set( 'ai_test_key', 'ai_value', 3600 );
+                $this->assertTrue( $set );
+
+                $value = wp_cache_get( 'ai_test_key', '12345' );
+                $this->assertSame( 'ai_value', $value );
+        }
 }