On this page
wp_should_replace_insecure_home_url(): bool
Checks whether WordPress should replace old HTTP URLs to the site with their HTTPS counterpart.
Description
If a WordPress site had its URL changed from HTTP to HTTPS, by default this will return true, causing WordPress to add frontend filters to replace insecure site URLs that may be present in older database content. The ‘wp_should_replace_insecure_home_url’ filter can be used to modify that behavior.
Return
bool True if insecure URLs should replaced, false otherwise.
Source
File: wp-includes/https-migration.php. View all references
function wp_should_replace_insecure_home_url() {
$should_replace_insecure_home_url = wp_is_using_https()
&& get_option( 'https_migration_required' )
// For automatic replacement, both 'home' and 'siteurl' need to not only use HTTPS, they also need to be using
// the same domain.
&& wp_parse_url( home_url(), PHP_URL_HOST ) === wp_parse_url( site_url(), PHP_URL_HOST );
/**
* Filters whether WordPress should replace old HTTP URLs to the site with their HTTPS counterpart.
*
* If a WordPress site had its URL changed from HTTP to HTTPS, by default this will return `true`. This filter can
* be used to disable that behavior, e.g. after having replaced URLs manually in the database.
*
* @since 5.7.0
*
* @param bool $should_replace_insecure_home_url Whether insecure HTTP URLs to the site should be replaced.
*/
return apply_filters( 'wp_should_replace_insecure_home_url', $should_replace_insecure_home_url );
}
Hooks
- apply_filters( 'wp_should_replace_insecure_home_url',
bool $should_replace_insecure_home_url ) -
Filters whether WordPress should replace old HTTP URLs to the site with their HTTPS counterpart.
Related
Uses
| Uses | Description |
|---|---|
| wp_is_using_https() wp-includes/https-detection.php | Checks whether the website is using HTTPS. |
| wp_parse_url() wp-includes/http.php | A wrapper for PHP’s parse_url() function that handles consistency in the return values across PHP versions. |
| site_url() wp-includes/link-template.php | Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. |
| home_url() wp-includes/link-template.php | Retrieves the URL for the current site where the front end is accessible. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
| get_option() wp-includes/option.php | Retrieves an option value based on an option name. |
Used By
| Used By | Description |
|---|---|
| wp_replace_insecure_home_url() wp-includes/https-migration.php | Replaces insecure HTTP URLs to the site in the given content, if configured to do so. |
Changelog
| Version | Description |
|---|---|
| 5.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_should_replace_insecure_home_url