Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CMSP-1056] TTL to max-age #41

Merged
merged 2 commits into from
Apr 25, 2024
Merged

[CMSP-1056] TTL to max-age #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae70097
change public-facing instances of TTL to use "max-age" instead
jazzsequence Apr 25, 2024
712803d
rename the filter, too
jazzsequence Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ add_filter( 'pantheon_wp_login_text', function() {
} );
```

#### `pantheon_cache_default_ttl`
Filter the default cache age for the Pantheon Edge Cache.
#### `pantheon_cache_default_max_age`
Filter the default cache max-age for the Pantheon Edge Cache.

**Default Value:** `WEEK_IN_SECONDS` (604800)

**Example:**
```php
add_filter( 'pantheon_cache_default_ttl', function() {
add_filter( 'pantheon_cache_default_max_age', function() {
return 2 * WEEK_IN_SECONDS;
} );
```
Expand Down
18 changes: 9 additions & 9 deletions inc/pantheon-page-cache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,16 +88,16 @@ protected function __construct() {
*/
protected function setup() {
/**
* Modify the default TTL for the Pantheon cache. Defaults to 1 week.
* Modify the default max-age for the Pantheon cache. Defaults to 1 week (604800 seconds).
*
* Usage:
* add_filter( 'pantheon_cache_default_ttl', function() {
* add_filter( 'pantheon_cache_default_max_age', function() {
* return DAY_IN_SECONDS;
* } );
*
* @param int $default_ttl The default TTL in seconds.
* @param int $default_ttl The default max-age in seconds.
*/
$default_ttl = apply_filters( 'pantheon_cache_default_ttl', WEEK_IN_SECONDS );
$default_ttl = apply_filters( 'pantheon_cache_default_max_age', WEEK_IN_SECONDS );

$this->options = get_option( self::SLUG, [] );
$this->default_options = [
Expand Down Expand Up @@ -221,19 +221,19 @@ public function action_admin_footer_trigger_plugin_open() {
}

/**
* Add the HTML for the default TTL field.
* Add the HTML for the default max-age field.
*
* @return void
*/
public function default_ttl_field() {
$disabled = ( has_filter( 'pantheon_cache_default_ttl' ) ) ? ' disabled' : '';
echo '<h3>' . esc_html__( 'Default Time to Live (TTL)', 'pantheon-cache' ) . '</h3>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo '<p>' . esc_html__( 'Maximum time a cached page will be served. A higher TTL typically improves site performance.', 'pantheon-cache' ) . '</p>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
$disabled = ( has_filter( 'pantheon_cache_default_max_age' ) ) ? ' disabled' : '';
echo '<h3>' . esc_html__( 'Default Max Age', 'pantheon-cache' ) . '</h3>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo '<p>' . esc_html__( 'Maximum time a cached page will be served. A higher max-age typically improves site performance.', 'pantheon-cache' ) . '</p>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo '<input type="text" name="' . self::SLUG . '[default_ttl]" value="' . $this->options['default_ttl'] . '" size="5" ' . $disabled . ' /> ' . esc_html__( 'seconds', 'pantheon-cache' ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

// Display a message if the setting is disabled.
if ( $disabled ) {
echo '<p>' . esc_html__( 'This setting is disabled because the default TTL has been filtered to the current value.', 'pantheon-cache' ) . '</p>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo '<p>' . esc_html__( 'This setting is disabled because the default max-age has been filtered to the current value.', 'pantheon-cache' ) . '</p>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
}

Expand Down
18 changes: 9 additions & 9 deletions tests/phpunit/test-page-cache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public function test_sanitize_empty_or_missing_values() {
];

$expected_output = [
'default_ttl' => 60, // Default TTL is set to 60 on live environments.
'default_ttl' => 60, // Default max-age is set to 60 on live environments.
'maintenance_mode' => 'disabled',
];
$output = $this->pantheon_cache->sanitize_options( $input );
Expand Down Expand Up @@ -194,21 +194,21 @@ public function test_enqueue_regex() {
}

/**
* Test the filtered value and display if the pantheon_cache_default_ttl filter is used.
* Test the filtered value and display if the pantheon_cache_default_max_age filter is used.
*/
public function test_pantheon_cache_default_ttl_filter() {
// Add a filter to change the default TTL to 120 seconds.
add_filter( 'pantheon_cache_default_ttl', function () {
public function test_pantheon_cache_default_max_age_filter() {
// Add a filter to change the default max-age to 120 seconds.
add_filter( 'pantheon_cache_default_max_age', function () {
return 120;
} );

// Get the filtered default TTL.
$filtered_default_ttl = apply_filters( 'pantheon_cache_default_ttl', get_option( 'default_ttl' ) );
// Get the filtered default max-age.
$filtered_default_ttl = apply_filters( 'pantheon_cache_default_max_age', get_option( 'default_ttl' ) );

// The filtered default TTL should be 120 seconds.
// The filtered default max-age should be 120 seconds.
$this->assertEquals( 120, $filtered_default_ttl );

// Remove the filter.
remove_all_filters( 'pantheon_cache_default_ttl' );
remove_all_filters( 'pantheon_cache_default_max_age' );
}
}
Loading