Merge branch 'master' of github.com:szepeviktor/tiny-cache

Author: szepeviktor

tiny-nav-menu-cache.php

@@ -16,7 +16,7 @@ class Tiny_Nav_Menu_Cache {
     /**
      * @var array List of whitelisted query string fields (these do not prevent cache write).
      */
-    private const WHITELISTED_QUERY_STRING_FIELDS = [
+    private $whitelisted_query_string_fields = [
         // https://support.google.com/searchads/answer/7342044
         'gclid',
         'gclsrc',
@@ -49,13 +49,23 @@ public function init() {
         add_action( 'split_shared_term', array( $this, 'flush_all' ) );
 
         // Learned from W3TC Page Cache rules and WP Super Cache rules
-        if ( is_user_logged_in() /* User is logged in */
-            || ! ( isset( $_SERVER['REQUEST_METHOD'] ) && 'GET' === $_SERVER['REQUEST_METHOD'] ) /* Not a GET request */ // WPCS: input var OK.
+	if ( is_user_logged_in() /* User is logged in */
+	    || ! ( isset( $_SERVER['REQUEST_METHOD'] ) && 'GET' === $_SERVER['REQUEST_METHOD'] ) /* Not a GET request */ // WPCS: input var OK.
             || ( defined( 'DONOTCACHEPAGE' ) && DONOTCACHEPAGE ) /* DO-NOT-CACHE tag present */
         ) {
             return;
         }
 
+	// Add user-defined query parameters to the whitelist. Define the parameters you
+	// want whitelisted in wp-config in the following way:
+	//
+	// define('TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS', 'XDEBUG_TRIGGER|do_xhprof_profile');
+
+	if ( defined( 'TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS' ) ) {
+		$fields = array_map( 'trim', explode( '|', TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS) );
+		$this->whitelisted_query_string_fields = array_merge( $this->whitelisted_query_string_fields, $fields );
+	}
+
         add_filter( 'pre_wp_nav_menu', array( $this, 'get_nav_menu' ), 30, 2 );
         add_filter( 'wp_nav_menu', array( $this, 'save_nav_menu' ), PHP_INT_MAX, 2 );
     }
@@ -71,7 +81,6 @@ public function get_nav_menu( $nav_menu_html, $args ) {
             $found = null;
             $cache = wp_cache_get( $this->get_cache_key( $args ), self::GROUP, false, $found );
             if ( $found ) {
-
                 return $cache;
             }
         }
@@ -152,7 +161,7 @@ private function is_enabled( $args ) {
 
         // Do not cache requests with query string except whitelisted ones.
         // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-        if ( [] !== array_diff( array_keys( $_GET ), self::WHITELISTED_QUERY_STRING_FIELDS ) ) {
+        if ( [] !== array_diff( array_keys( $_GET ), $this->whitelisted_query_string_fields) ) {
             return false;
         }
 
@@ -169,7 +178,7 @@ private function get_cache_key( $args ) {
             ? $_SERVER['REQUEST_URI']
             : ''; // WPCS: sanitization, input var OK.
 
-        return md5( wp_json_encode( $args ) . $request_uri );
+        return md5( 'nav_menu-' . $args->menu_id . $request_uri );
     }
 }