gcapi_gppa_cache_key

  1. Description
  2. Usage
  3. Parameters
  4. Examples
    1. User-specific caching
    2. Role-based caching
    3. Site-specific caching (Multisite)
    4. Language-specific caching
    5. Conditional user caching based on endpoint
  5. Since

Description

Filter the cache key for GPPA endpoint responses.

Usage

Applied globally

add_filter( 'gcapi_gppa_cache_key', 'my_custom_function' );

Parameters

$cache_key string

The generated cache key.

$request Webhook_Request

The webhook request object.

$endpoint_config array

The GPPA endpoint configuration.

Examples

User-specific caching

add_filter( ‘gcapi_gppa_cache_key’, function( $cache_key ) { return $cache_key . ‘user‘ . get_current_user_id(); });

Role-based caching

add_filter( ‘gcapi_gppa_cache_key’, function( $cache_key ) { $user = wp_get_current_user(); return $cache_key . ‘role‘ . $user->roles[0]; });

Site-specific caching (Multisite)

add_filter( ‘gcapi_gppa_cache_key’, function( $cache_key ) { return $cache_key . ‘site‘ . get_current_blog_id(); });

Language-specific caching

add_filter( ‘gcapi_gppa_cache_key’, function( $cache_key ) { return $cache_key . ‘lang‘ . get_locale(); });

Conditional user caching based on endpoint

add_filter( ‘gcapi_gppa_cache_key’, function( $cache_key, $request, $endpoint_config ) { if ( $endpoint_config[‘user_specific’] ?? false ) { $cache_key .= ‘user‘ . get_current_user_id(); } return $cache_key; }, 10, 3 );

Since

  • 1.0.0 Hook added.