WP_Site_Health::get_page_cache_detail(): WP_Error|array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

WP_Error|array

Page cache detail or else a WP_Error if unable to determine.

• $statusstring

  Page cache status. Good, Recommended or Critical.

• $advanced_cache_presentbool

  Whether page cache plugin is available or not.

• $headersstring[]

  Client caching response headers detected.

• $response_timefloat

  Response time of site.

Performance profile

How much work a call to WP_Site_Health::get_page_cache_detail() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

8–48

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 60.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()one call below WP_Site_Health::get_page_cache_detail()

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Site_Health::get_page_cache_detail() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_Site_Health::check_for_page_caching()Checks if site has page cache enabled or not.
• WP_Site_Health::get_good_response_time_threshold()Gets the threshold below which a response time is considered good.

Used by · 1

• WP_Site_Health::get_test_page_cache()Tests if a full page cache is available.

Source code

View on Trac ↗View on GitHub ↗

3692	private function get_page_cache_detail() {3693		$page_cache_detail = $this->check_for_page_caching();3694		if ( is_wp_error( $page_cache_detail ) ) {3695			return $page_cache_detail;3696		}3697 3698		// Use the median server response time.3699		$response_timings = $page_cache_detail['response_timing'];3700		rsort( $response_timings );3701		$page_speed = $response_timings[ floor( count( $response_timings ) / 2 ) ];3702 3703		// Obtain unique set of all client caching response headers.3704		$headers = array();3705		foreach ( $page_cache_detail['page_caching_response_headers'] as $page_caching_response_headers ) {3706			$headers = array_merge( $headers, array_keys( $page_caching_response_headers ) );3707		}3708		$headers = array_unique( $headers );3709 3710		// Page cache is detected if there are response headers or a page cache plugin is present.3711		$has_page_caching = ( count( $headers ) > 0 || $page_cache_detail['advanced_cache_present'] );3712 3713		if ( $page_speed && $page_speed < $this->get_good_response_time_threshold() ) {3714			$result = $has_page_caching ? 'good' : 'recommended';3715		} else {3716			$result = 'critical';3717		}3718 3719		return array(3720			'status'                 => $result,3721			'advanced_cache_present' => $page_cache_detail['advanced_cache_present'],3722			'headers'                => $headers,3723			'response_time'          => $page_speed,3724		);3725	}

Changelog

Introduced in 6.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-wp-site-health.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.