wp_get_https_detection_errors(): array

Description

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

array

An array containing potential detection errors related to HTTPS, or an empty array if no errors are found.

Performance profile

How much work a call to wp_get_https_detection_errors() 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

Expensive

Reaches an outbound HTTP request via wp_remote_request().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11–73

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

Plugin surface

1 hook

Third-party callbacks on 'pre_wp_get_https_detection_errors' run inside this call, and their cost is not bounded by anything here.

Called by

3

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• httpoutbound HTTP requestwp_remote_request()called directly

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 9 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_get_https_detection_errors() runs, in this order:

1. 1
   apply_filters( pre_wp_get_https_detection_errors )filterline 106 (+12 into the body)

   Short-circuits the process of detecting errors related to HTTPS support.

Uses · 10

• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_remote_request()Performs an HTTP request and returns its response.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• __()Retrieves the translation of $text.
• wp_remote_retrieve_response_code()Retrieves only the response code from the raw response.
• wp_remote_retrieve_response_message()Retrieves only the response message from the raw response.
• wp_is_local_html_output()Checks whether a given HTML string is likely an output from this WordPress site.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• WP_Error::__construct()Initializes the error.

Used by · 3

• WP_Site_Health::get_test_https_status()Tests if the site is serving content over HTTPS.
• wp_is_https_supported()Checks whether HTTPS is supported for the server and domain.
• wp_update_https_detection_errors()Runs a remote HTTPS request to detect whether HTTPS supported, and stores potential errors.

Source code

View on Trac ↗View on GitHub ↗

94function wp_get_https_detection_errors() {95	/**96	 * Short-circuits the process of detecting errors related to HTTPS support.97	 *98	 * Returning a `WP_Error` from the filter will effectively short-circuit the default logic of trying a remote99	 * request to the site over HTTPS, storing the errors array from the returned `WP_Error` instead.100	 *101	 * @since 6.4.0102	 *103	 * @param null|WP_Error $pre Error object to short-circuit detection,104	 *                           or null to continue with the default behavior.105	 */106	$support_errors = apply_filters( 'pre_wp_get_https_detection_errors', null );107	if ( is_wp_error( $support_errors ) ) {108		return $support_errors->errors;109	}110 111	$support_errors = new WP_Error();112 113	$response = wp_remote_request(114		home_url( '/', 'https' ),115		array(116			'headers'   => array(117				'Cache-Control' => 'no-cache',118			),119			'sslverify' => true,120		)121	);122 123	if ( is_wp_error( $response ) ) {124		$unverified_response = wp_remote_request(125			home_url( '/', 'https' ),126			array(127				'headers'   => array(128					'Cache-Control' => 'no-cache',129				),130				'sslverify' => false,131			)132		);133 134		if ( is_wp_error( $unverified_response ) ) {135			$support_errors->add(136				'https_request_failed',137				__( 'HTTPS request failed.' )138			);139		} else {140			$support_errors->add(141				'ssl_verification_failed',142				__( 'SSL verification failed.' )143			);144		}145 146		$response = $unverified_response;147	}148 149	if ( ! is_wp_error( $response ) ) {150		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {151			$support_errors->add( 'bad_response_code', wp_remote_retrieve_response_message( $response ) );152		} elseif ( false === wp_is_local_html_output( wp_remote_retrieve_body( $response ) ) ) {153			$support_errors->add( 'bad_response_source', __( 'It looks like the response did not come from this site.' ) );154		}155	}156 157	return $support_errors->errors;158}

Changelog

Introduced in 6.4.0. One change between 6.7.7 and 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-includes/https-detection.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.