WP_Site_Health::get_test_https_status(): 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

The test results.

Performance profile

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

47–142

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()one call below WP_Site_Health::get_test_https_status()
• httpoutbound HTTP requestwp_remote_request()one call below WP_Site_Health::get_test_https_status()
• optionoption read or writeget_option()one call below WP_Site_Health::get_test_https_status()

Further down the call graph this can also reach 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 · 13 distinct outcomes

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

Uses · 14

• wp_get_https_detection_errors()Runs a remote HTTPS request to detect whether HTTPS supported, and stores potential errors.
• wp_get_default_update_https_url()Gets the default URL to learn more about updating the site to use HTTPS.
• __()Retrieves the translation of $text.
• esc_url()Checks and cleans a URL.
• wp_is_using_https()Checks whether the website is using HTTPS.
• wp_is_site_url_using_https()Checks whether the current site's URL where WordPress is stored is using HTTPS.
• is_ssl()Determines if SSL is used.
• admin_url()Retrieves the URL to the admin area for the current site.
• wp_is_https_supported()Checks whether HTTPS is supported for the server and domain.
• current_user_can()Returns whether the current user has the specified capability.
• add_query_arg()Retrieves a modified URL query string.
• wp_nonce_url()Retrieves URL with nonce added to URL query.

Source code

View on Trac ↗View on GitHub ↗

1473	public function get_test_https_status() {1474		/*1475		 * Check HTTPS detection results.1476		 */1477		$errors = wp_get_https_detection_errors();1478 1479		$default_update_url = wp_get_default_update_https_url();1480 1481		$result = array(1482			'label'       => __( 'Your website is using an active HTTPS connection' ),1483			'status'      => 'good',1484			'badge'       => array(1485				'label' => __( 'Security' ),1486				'color' => 'blue',1487			),1488			'description' => sprintf(1489				'<p>%s</p>',1490				__( 'An HTTPS connection is a more secure way of browsing the web. Many services now have HTTPS as a requirement. HTTPS allows you to take advantage of new features that can increase site speed, improve search rankings, and gain the trust of your visitors by helping to protect their online privacy.' )1491			),1492			'actions'     => sprintf(1493				'<p><a href="%s" target="_blank">%s<span class="screen-reader-text"> %s</span><span aria-hidden="true" class="dashicons dashicons-external"></span></a></p>',1494				esc_url( $default_update_url ),1495				__( 'Learn more about why you should use HTTPS' ),1496				/* translators: Hidden accessibility text. */1497				__( '(opens in a new tab)' )1498			),1499			'test'        => 'https_status',1500		);1501 1502		if ( ! wp_is_using_https() ) {1503			/*1504			 * If the website is not using HTTPS, provide more information1505			 * about whether it is supported and how it can be enabled.1506			 */1507			$result['status'] = 'recommended';1508			$result['label']  = __( 'Your website does not use HTTPS' );1509 1510			if ( wp_is_site_url_using_https() ) {1511				if ( is_ssl() ) {1512					$result['description'] = sprintf(1513						'<p>%s</p>',1514						sprintf(1515							/* translators: %s: URL to Settings > General > Site Address. */1516							__( 'You are accessing this website using HTTPS, but your <a href="%s">Site Address</a> is not set up to use HTTPS by default.' ),1517							esc_url( admin_url( 'options-general.php' ) . '#home' )1518						)1519					);1520				} else {1521					$result['description'] = sprintf(1522						'<p>%s</p>',1523						sprintf(1524							/* translators: %s: URL to Settings > General > Site Address. */1525							__( 'Your <a href="%s">Site Address</a> is not set up to use HTTPS.' ),1526							esc_url( admin_url( 'options-general.php' ) . '#home' )1527						)1528					);1529				}1530			} else {1531				if ( is_ssl() ) {1532					$result['description'] = sprintf(1533						'<p>%s</p>',1534						sprintf(1535							/* translators: 1: URL to Settings > General > WordPress Address, 2: URL to Settings > General > Site Address. */1536							__( 'You are accessing this website using HTTPS, but your <a href="%1$s">WordPress Address</a> and <a href="%2$s">Site Address</a> are not set up to use HTTPS by default.' ),1537							esc_url( admin_url( 'options-general.php' ) . '#siteurl' ),1538							esc_url( admin_url( 'options-general.php' ) . '#home' )1539						)1540					);1541				} else {1542					$result['description'] = sprintf(1543						'<p>%s</p>',1544						sprintf(1545							/* translators: 1: URL to Settings > General > WordPress Address, 2: URL to Settings > General > Site Address. */1546							__( 'Your <a href="%1$s">WordPress Address</a> and <a href="%2$s">Site Address</a> are not set up to use HTTPS.' ),1547							esc_url( admin_url( 'options-general.php' ) . '#siteurl' ),1548							esc_url( admin_url( 'options-general.php' ) . '#home' )1549						)1550					);1551				}1552			}

Changelog

Introduced in 5.2.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.