Changeset 50131 for trunk/src/wp-includes/functions.php

Timestamp:

02/02/2021 12:08:01 AM (3 years ago)

Author:

flixos90

Message:

Security, Site Health: Make migrating a site to HTTPS a one-click interaction.

Switching a WordPress site from HTTP to HTTPS has historically been a tedious task. While on the surface the Site Address and WordPress Address have to be updated, existing content still remains using HTTP URLs where hard-coded in the database. Furthermore, updating _two_ URLs to migrate to HTTPS is still a fairly unintuitive step which is not clearly explained.

This changeset simplifies migration from HTTP to HTTPS and, where possible, makes it a one-click interaction.

• Automatically replace insecure versions of the Site Address (home_url()) with its HTTPS counterpart on the fly if the site has been migrated from HTTP to HTTPS. This is accomplished by introducing a https_migration_required option and enabling it when the home_url() is accordingly changed.
  • A new wp_replace_insecure_home_url() function is hooked into various pieces of content to replace URLs accordingly.
  • The migration only kicks in when the Site Address (home_url()) and WordPress Address (site_url()) match, which is the widely common case. Configurations where these differ are often maintained by more advanced users, where this migration routine would be less essential - something to potentially iterate on in the future though.
  • The migration does not actually update content in the database. More savvy users that prefer to do that can prevent the migration logic from running by either deleting the https_migration_required option or using the new wp_should_replace_insecure_home_url filter.
  • For fresh sites that do not have any content yet at the point of changing the URLs to HTTPS, the migration will also be skipped since it would not be relevant.
• Expose a primary action in the Site Health recommendation, if HTTPS is already supported by the environment, built on top of the HTTPS detection mechanism from [49904]. When clicked, the default behavior is to update home_url() and site_url() in one go to their HTTPS counterpart.
  • A new wp_update_urls_to_https() function takes care of the update routine.
  • A new update_https meta capability is introduced to control access.
  • If the site's URLs are controlled by constants, this update is not automatically possible, so in these scenarios the user is informed about that in the HTTPS status check in Site Health.
• Allow hosting providers to modify the URLs linked to in the HTTPS status check in Site Health, similar to how that is possible for the URLs around updating the PHP version.
  • A WP_UPDATE_HTTPS_URL environment variable or wp_update_https_url filter can be used to provide a custom URL with guidance about updating the site to use HTTPS.
  • A WP_DIRECT_UPDATE_HTTPS_URL environment variable or wp_direct_update_https_url filter can be used to provide a custom URL for the primary CTA to update the site to use HTTPS.

Props flixos90, timothyblynjacobs.
Fixes #51437.

File:

• trunk/src/wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -7582 +7582 @@
 
 /**
+ * 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
+ * {@see '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.
+ *
+ * @since 5.7.0
+ *
+ * @return string URL to learn more about updating to HTTPS.
+ */
+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;
+}
+
+/**
+ * Gets the default URL to learn more about updating the site to use HTTPS.
+ *
+ * Do not use this function to retrieve this URL. Instead, use {@see wp_get_update_https_url()} when relying on the URL.
+ * This function does not allow modifying the returned URL, and is only used to compare the actually used URL with the
+ * default one.
+ *
+ * @since 5.7.0
+ * @access private
+ *
+ * @return string Default URL to learn more about updating to HTTPS.
+ */
+function wp_get_default_update_https_url() {
+    /* translators: Documentation explaining HTTPS and why it should be used. */
+    return __( 'https://wordpress.org/support/article/why-should-i-use-https/' );
+}
+
+/**
+ * Gets the URL for directly updating the site to use HTTPS.
+ *
+ * A URL will only be returned if the `WP_DIRECT_UPDATE_HTTPS_URL` environment variable is specified or
+ * by using the {@see 'wp_direct_update_https_url'} filter. This allows hosts to send users directly to
+ * the page where they can update their site to use HTTPS.
+ *
+ * @since 5.7.0
+ *
+ * @return string URL for directly updating to HTTPS or empty string.
+ */
+function wp_get_direct_update_https_url() {
+    $direct_update_url = '';
+
+    if ( false !== getenv( 'WP_DIRECT_UPDATE_HTTPS_URL' ) ) {
+        $direct_update_url = getenv( 'WP_DIRECT_UPDATE_HTTPS_URL' );
+    }
+
+    /**
+     * Filters the URL for directly updating the PHP version the site is running on from the host.
+     *
+     * @since 5.7.0
+     *
+     * @param string $direct_update_url URL for directly updating PHP.
+     */
+    $direct_update_url = apply_filters( 'wp_direct_update_https_url', $direct_update_url );
+
+    return $direct_update_url;
+}
+
+/**
  * Get the size of a directory.
  *