wp_should_replace_insecure_home_url(): bool
- Since
- 5.7.0
- Source
wp-includes/https-migration.php:20
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.
Compatibility
- WordPress
- since 5.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Return value
bool- True if insecure URLs should replaced, false otherwise.
Performance profile
How much work a call to wp_should_replace_insecure_home_url() 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
- Moderate
- Scaling
- Constant
- Instructions
- 9–26
- Plugin surface
- 1 hook
- Called by
- 1
Reads stored settings via get_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 26.
Third-party callbacks on 'wp_should_replace_insecure_home_url' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - cacheobject cache
wp_cache_get()one call below wp_should_replace_insecure_home_url() - serializeserialisation
maybe_unserialize()one call below wp_should_replace_insecure_home_url()
Further down the call graph this can also reach 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_should_replace_insecure_home_url() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!wp_is_using_https() | 9 | wp_is_using_https(), apply_filters() |
wp_is_using_https() && !get_option() | 13 | wp_is_using_https(), get_option(), apply_filters() |
wp_is_using_https() && get_option() | 26 | wp_is_using_https(), get_option(), home_url(), wp_parse_url(), site_url(), wp_parse_url(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 26 instructions, 9–26 executed per call, 2 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while wp_should_replace_insecure_home_url() runs, in this order:
- apply_filters( wp_should_replace_insecure_home_url )filterline 37 (+17 into the body)
Filters whether WordPress should replace old HTTP URLs to the site with their HTTPS counterpart.
Uses · 6
- wp_is_using_https()Checks whether the website is using HTTPS.
- get_option()Retrieves an option value based on an option name.
- wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.
- home_url()Retrieves the URL for the current site where the front end is accessible.
- site_url()Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- wp_replace_insecure_home_url()Replaces insecure HTTP URLs to the site in the given content, if configured to do so.
Source code
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 );}Changelog
Introduced in 5.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/https-migration.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.