gcapi_gppa_cache_duration

  1. Description
  2. Usage
  3. Parameters
  4. Examples
    1. Shorter cache for real-time data
    2. Longer cache for static reference data
  5. Since

Description

Filter the cache duration for GPPA endpoint responses.

Usage

Applied globally

add_filter( 'gcapi_gppa_cache_duration', 'my_custom_function' );

Parameters

$duration int

Cache duration in seconds.

$endpoint_config array

The GPPA endpoint configuration.

$response_data array

Response data being cached.

Examples

Shorter cache for real-time data

add_filter( ‘gcapi_gppa_cache_duration’, function( $duration, $endpoint_config ) { if ( str_contains( $endpoint_config[‘endpoint_path’] ?? ”, ‘/real-time/’ ) ) { return 60; // 1 minute } return $duration; }, 10, 2 );

Longer cache for static reference data

add_filter( ‘gcapi_gppa_cache_duration’, function( $duration, $endpoint_config ) { if ( $endpoint_config[‘name’] === ‘Countries List’ ) { return DAY_IN_SECONDS; // 24 hours } return $duration; }, 10, 2 );

Since

  • 1.0.0 Hook added.