Skip to content

Improve Site Health Page Cache Detection Logic #10606

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

Open
solankisoftware89 wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Improve Site Health Page Cache Detection Logic #10606

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
293 changes: 180 additions & 113 deletions src/wp-admin/includes/class-wp-site-health.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,70 @@
return apply_filters( 'site_status_test_result', call_user_func( $callback ) );
}

/**
* Detect cache status from headers.
*
* @param array $headers Response headers.
* @return bool Whether cache was detected.
*/
private function detect_cache_headers( $headers ) {
Copy link
Member

@westonruter westonruter Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are many PHPCS coding standards issues in this method.


// Normalize header names & values.

Check failure on line 205 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
$normalized = array();

Check failure on line 206 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
foreach ( $headers as $key => $value ) {

Check failure on line 207 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
$normalized[ strtolower( $key ) ] = strtolower( $value );

Check failure on line 208 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
}

Check failure on line 209 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed

// Common server / CDN / proxy cache headers.

Check failure on line 211 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
$cache_headers = array(

Check failure on line 212 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
'x-cache',

Check failure on line 213 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
'x-cache-status',

Check failure on line 214 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
'cf-cache-status',

Check failure on line 215 in src/wp-admin/includes/class-wp-site-health.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Tabs must be used to indent lines; spaces are not allowed
'x-varnish',
'x-pass',
'x-proxy-cache',
'x-litespeed-cache',
);

/**
* Allow hosts / plugins to add additional cache headers.
*/
$cache_headers = apply_filters( 'site_health_cache_headers', $cache_headers );

// Valid cache status values.
$valid_values = array(
'hit',
'miss',
'pass',
'skip',
'expired',
'revalidated',
'reload',
'refresh',
'dynamic',
'bypass',
);

foreach ( $cache_headers as $header ) {
if ( isset( $normalized[ $header ] ) ) {

$value = trim( $normalized[ $header ] );

// Exact match.
if ( in_array( $value, $valid_values, true ) ) {
return true;
}

// Match phrases: "HIT from varnish", etc.
if ( preg_match( '/\b(' . implode( '|', $valid_values ) . ')\b/i', $value ) ) {
return true;
}
}
}

return false;
}

/**
* Runs the SQL version checks.
*
Expand Down Expand Up @@ -2407,110 +2471,123 @@
* @return array The test result.
*/
public function get_test_page_cache() {
$description = '<p>' . __( 'Page cache enhances the speed and performance of your site by saving and serving static pages instead of calling for a page every time a user visits.' ) . '</p>';
Copy link
Member

@westonruter westonruter Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are all of these lines modified?

$description .= '<p>' . __( 'Page cache is detected by looking for an active page cache plugin as well as making three requests to the homepage and looking for one or more of the following HTTP client caching response headers:' ) . '</p>';
$description .= '<code>' . implode( '</code>, <code>', array_keys( $this->get_page_cache_headers() ) ) . '.</code>';

$result = array(
'badge' => array(
'label' => __( 'Performance' ),
'color' => 'blue',
),
'description' => wp_kses_post( $description ),
'test' => 'page_cache',
'status' => 'good',
'label' => '',
'actions' => sprintf(
'<p><a href="%1$s" target="_blank" rel="noreferrer">%2$s<span class="screen-reader-text"> %3$s</span><span aria-hidden="true" class="dashicons dashicons-external"></span></a></p>',
__( 'https://developer.wordpress.org/advanced-administration/performance/optimization/#caching' ),
__( 'Learn more about page cache' ),
/* translators: Hidden accessibility text. */
Copy link
Member

@westonruter westonruter Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this comment removed?

__( '(opens in a new tab)' )
),
);

$page_cache_detail = $this->get_page_cache_detail();

if ( is_wp_error( $page_cache_detail ) ) {
$result['label'] = __( 'Unable to detect the presence of page cache' );
$result['status'] = 'recommended';
$error_info = sprintf(
/* translators: 1: Error message, 2: Error code. */
__( 'Unable to detect page cache due to possible loopback request problem. Please verify that the loopback request test is passing. Error: %1$s (Code: %2$s)' ),
$page_cache_detail->get_error_message(),
$page_cache_detail->get_error_code()
);
$result['description'] = wp_kses_post( "<p>$error_info</p>" ) . $result['description'];
return $result;
}

$result['status'] = $page_cache_detail['status'];

switch ( $page_cache_detail['status'] ) {
case 'recommended':
$result['label'] = __( 'Page cache is not detected but the server response time is OK' );
break;
case 'good':
$result['label'] = __( 'Page cache is detected and the server response time is good' );
break;
default:
if ( empty( $page_cache_detail['headers'] ) && ! $page_cache_detail['advanced_cache_present'] ) {
$result['label'] = __( 'Page cache is not detected and the server response time is slow' );
} else {
$result['label'] = __( 'Page cache is detected but the server response time is still slow' );
}
}

$page_cache_test_summary = array();

if ( empty( $page_cache_detail['response_time'] ) ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-dismiss" aria-hidden="true"></span> ' . __( 'Server response time could not be determined. Verify that loopback requests are working.' );
} else {

$threshold = $this->get_good_response_time_threshold();
if ( $page_cache_detail['response_time'] < $threshold ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-yes-alt" aria-hidden="true"></span> ' . sprintf(
/* translators: 1: The response time in milliseconds, 2: The recommended threshold in milliseconds. */
__( 'Median server response time was %1$s milliseconds. This is less than the recommended %2$s milliseconds threshold.' ),
number_format_i18n( $page_cache_detail['response_time'] ),
number_format_i18n( $threshold )
);
} else {
$page_cache_test_summary[] = '<span class="dashicons dashicons-warning" aria-hidden="true"></span> ' . sprintf(
/* translators: 1: The response time in milliseconds, 2: The recommended threshold in milliseconds. */
__( 'Median server response time was %1$s milliseconds. It should be less than the recommended %2$s milliseconds threshold.' ),
number_format_i18n( $page_cache_detail['response_time'] ),
number_format_i18n( $threshold )
);
}

if ( empty( $page_cache_detail['headers'] ) ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-warning" aria-hidden="true"></span> ' . __( 'No client caching response headers were detected.' );
} else {
$headers_summary = '<span class="dashicons dashicons-yes-alt" aria-hidden="true"></span>';
$headers_summary .= ' ' . sprintf(
/* translators: %d: Number of caching headers. */
_n(
'There was %d client caching response header detected:',
'There were %d client caching response headers detected:',
count( $page_cache_detail['headers'] )
),
count( $page_cache_detail['headers'] )
);
$headers_summary .= ' <code>' . implode( '</code>, <code>', $page_cache_detail['headers'] ) . '</code>.';
$page_cache_test_summary[] = $headers_summary;
}
}

if ( $page_cache_detail['advanced_cache_present'] ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-yes-alt" aria-hidden="true"></span> ' . __( 'A page cache plugin was detected.' );
} elseif ( ! ( is_array( $page_cache_detail ) && ! empty( $page_cache_detail['headers'] ) ) ) {
// Note: This message is not shown if client caching response headers were present since an external caching layer may be employed.
$page_cache_test_summary[] = '<span class="dashicons dashicons-warning" aria-hidden="true"></span> ' . __( 'A page cache plugin was not detected.' );
}

$result['description'] .= '<ul><li>' . implode( '</li><li>', $page_cache_test_summary ) . '</li></ul>';
return $result;
$description = '<p>' . __( 'Page cache enhances the speed and performance of your site by saving and serving static pages instead of calling for a page every time a user visits.' ) . '</p>';
$description .= '<p>' . __( 'Page cache is detected by looking for an active page cache plugin as well as making three requests to the homepage and looking for one or more of the following HTTP client caching response headers:' ) . '</p>';
$description .= '<code>' . implode( '</code>, <code>', array_keys( $this->get_page_cache_headers() ) ) . '.</code>';

$result = array(
'badge' => array(
'label' => __( 'Performance' ),
'color' => 'blue',
),
'description' => wp_kses_post( $description ),
'test' => 'page_cache',
'status' => 'good',
'label' => '',
'actions' => sprintf(
'<p><a href="%1$s" target="_blank" rel="noreferrer">%2$s<span class="screen-reader-text"> %3$s</span><span aria-hidden="true" class="dashicons dashicons-external"></span></a></p>',
__( 'https://developer.wordpress.org/advanced-administration/performance/optimization/#caching' ),
__( 'Learn more about page cache' ),
__( '(opens in a new tab)' )
),
);

// Get detailed page cache info.
$page_cache_detail = $this->get_page_cache_detail();

if ( is_wp_error( $page_cache_detail ) ) {
$result['label'] = __( 'Unable to detect the presence of page cache' );
$result['status'] = 'recommended';
$error_info = sprintf(
__( 'Unable to detect page cache due to possible loopback request problem. Please verify that the loopback request test is passing. Error: %1$s (Code: %2$s)' ),
$page_cache_detail->get_error_message(),
$page_cache_detail->get_error_code()
);
$result['description'] = wp_kses_post( "<p>$error_info</p>" ) . $result['description'];
return $result;
}

// Override default WP header detection with YOUR improved detection
$cache_detected = false;
if ( ! empty( $page_cache_detail['response_headers_raw'] ) ) {
foreach ( $page_cache_detail['response_headers_raw'] as $header_group ) {
if ( $this->detect_cache_headers( $header_group ) ) {
$cache_detected = true;
break;
}
}
}

// Rewrite status logic using new detection
if ( $cache_detected ) {
$page_cache_detail['headers'] = array( 'cache-detected' ); // fake entry to trigger WP's UI output
$page_cache_detail['status'] = 'good';
} else {
$page_cache_detail['headers'] = array();
$page_cache_detail['status'] = 'recommended';
}

$result['status'] = $page_cache_detail['status'];

switch ( $page_cache_detail['status'] ) {
case 'recommended':
$result['label'] = __( 'Page cache is not detected but the server response time is OK' );
break;

case 'good':
$result['label'] = __( 'Page cache is detected and the server response time is good' );
break;

default:
if ( empty( $page_cache_detail['headers'] ) && ! $page_cache_detail['advanced_cache_present'] ) {
$result['label'] = __( 'Page cache is not detected and the server response time is slow' );
} else {
$result['label'] = __( 'Page cache is detected but the server response time is still slow' );
}
}

$page_cache_test_summary = array();

// Response time
if ( empty( $page_cache_detail['response_time'] ) ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-dismiss"></span> ' . __( 'Server response time could not be determined. Verify that loopback requests are working.' );
} else {
$threshold = $this->get_good_response_time_threshold();

if ( $page_cache_detail['response_time'] < $threshold ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-yes-alt"></span> ' . sprintf(
__( 'Median server response time was %1$s milliseconds. This is less than the recommended %2$s milliseconds threshold.' ),
number_format_i18n( $page_cache_detail['response_time'] ),
number_format_i18n( $threshold )
);
} else {
$page_cache_test_summary[] = '<span class="dashicons dashicons-warning"></span> ' . sprintf(
__( 'Median server response time was %1$s milliseconds. It should be less than the recommended %2$s milliseconds threshold.' ),
number_format_i18n( $page_cache_detail['response_time'] ),
number_format_i18n( $threshold )
);
}

// Your new header detection integrated here
if ( ! $cache_detected ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-warning"></span> ' . __( 'No client caching response headers were detected.' );
} else {
$page_cache_test_summary[] = '<span class="dashicons dashicons-yes-alt"></span> ' .
__( 'Page cache headers were detected using enhanced header analysis.' );
}
}

// Page cache plugin availability
if ( $page_cache_detail['advanced_cache_present'] ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-yes-alt"></span> ' . __( 'A page cache plugin was detected.' );
} elseif ( ! $cache_detected ) {
$page_cache_test_summary[] = '<span class="dashicons dashicons-warning"></span> ' . __( 'A page cache plugin was not detected.' );
}

$result['description'] .= '<ul><li>' . implode( '</li><li>', $page_cache_test_summary ) . '</li></ul>';

return $result;
}

/**
Expand Down Expand Up @@ -3412,16 +3489,6 @@
},
'x-srcache-store-status' => $cache_hit_callback,
'x-srcache-fetch-status' => $cache_hit_callback,

// Generic caching proxies (Nginx, Varnish, etc.)
'x-cache' => $cache_hit_callback,
'x-cache-status' => $cache_hit_callback,
'x-litespeed-cache' => $cache_hit_callback,
'x-proxy-cache' => $cache_hit_callback,
'via' => '',

// Cloudflare
'cf-cache-status' => $cache_hit_callback,
Comment on lines -3415 to -3424
Copy link
Member

@westonruter westonruter Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are these removed from this list but the others are left intact?

);

/**
Expand Down
Loading