wp_get_update_https_url() │ WP 5.7.0

Gets the URL to learn more about updating the site to use HTTPS.

This URL can be overridden by specifying an environment variable WP_UPDATE_HTTPS_URL or by using the wp_update_https_url filter. Providing an empty string is not allowed and will result in the default URL being used. Furthermore the page the URL links to should preferably be localized in the site language.

Returns

String. URL to learn more about updating to HTTPS.

Usage

wp_get_update_https_url();

Changelog

wp_get_update_https_url() wp get update https url code ^{WP 6.8.1}

function wp_get_update_https_url() {
	$default_url = wp_get_default_update_https_url();

	$update_url = $default_url;
	if ( false !== getenv( 'WP_UPDATE_HTTPS_URL' ) ) {
		$update_url = getenv( 'WP_UPDATE_HTTPS_URL' );
	}

	/**
	 * Filters the URL to learn more about updating the HTTPS version the site is running on.
	 *
	 * Providing an empty string is not allowed and will result in the default URL being used. Furthermore
	 * the page the URL links to should preferably be localized in the site language.
	 *
	 * @since 5.7.0
	 *
	 * @param string $update_url URL to learn more about updating HTTPS.
	 */
	$update_url = apply_filters( 'wp_update_https_url', $update_url );
	if ( empty( $update_url ) ) {
		$update_url = $default_url;
	}

	return $update_url;
}