orbit-cache-compat

What problem does it solve?

Detects incompatibilities in WordPress plugins that could lead to performance issues due to improper use of object and page caches, such as plugins that store mutable data without invalidation, set cookies that bust the page cache, or read from wp_options without respecting the cache.

Core Features & Use Cases

• Object Cache Awareness: Checks for proper use of object caches like Redis and Memcached.
• Cache Invalidation on Writes: Ensures that plugins invalidate caches on data writes.
• Page Cache Bustining Cookies: Verifies that plugins do not set cookies that bust the page cache for all users.
• nocache_headers() Overuse: Identifies overuse of nocache_headers() which can disable page caching for the entire site.
• Transient Explosion: Alerts about excessive use of transients that can lead to database overload.
• Object Cache Key Collisions: Checks for key collisions in object cache usage.
• Honour WP_CACHE Constant: Ensures that plugins respect the WP_CACHE constant.
• Page Cache Plugin Compatibility: Verifies compatibility with popular page caching plugins like W3 Total Cache, WP Rocket, LiteSpeed, and Varnish.
• Test on Object Cache: Provides instructions to test object cache functionality with wp-env and Redis.

Quick Start

Run the object cache compatibility check on your plugin with the command: bash ~/Claude/orbit/scripts/check-object-cache.sh ~/plugins/my-plugin