wp_update_https_migration_required( mixed $old_url, mixed $new_url )
- Since
- 5.7.0
- Source
wp-includes/https-migration.php:126
Description
If this is a fresh site, a migration will not be required, so the option will be set as false.
This is hooked into the 'update_option_home' action.
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.
Parameters
$old_urlmixed- Previous value of the URL option.
$new_urlmixed- New value of the URL option.
Performance profile
How much work a call to wp_update_https_migration_required() 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
- 6–29
- Plugin surface
- None
- Called by
- 0
Reads stored settings via delete_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 35.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- optionoption read or write
delete_option()called directly - hookthird-party callbacks
do_action()one call below wp_update_https_migration_required() - cacheobject cache
wp_cache_set()one call below wp_update_https_migration_required() - serializeserialisation
maybe_unserialize()one call below wp_update_https_migration_required()
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_update_https_migration_required() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
wp_installing() | 6 | wp_installing() |
!wp_installing() | 21 | wp_installing(), untrailingslashit(), untrailingslashit(), delete_option() |
!wp_installing() | 28–29 | wp_installing(), untrailingslashit(), untrailingslashit(), get_option(), update_option() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 35 | 6–29 | 3 | |
| 8.5 | 35 | 6–29 | 3 | |
| 8.4 | 35 | 6–29 | 3 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 38 | 6–32 | 3 | |
| 8.2 | 38 | 6–32 | 3 | |
| 8.1 | 38 | 6–32 | 3 | |
| 7.4 | 38 | 6–32 | 3 |
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.
Uses · 5
- wp_installing()Checks or sets whether WordPress is in "installation" mode.
- untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
- delete_option()Removes an option by name. Prevents removal of protected WordPress options.
- get_option()Retrieves an option value based on an option name.
- update_option()Updates the value of an option that was already added.
Source code
function wp_update_https_migration_required( $old_url, $new_url ) { // Do nothing if WordPress is being installed. if ( wp_installing() ) { return; } // Delete/reset the option if the new URL is not the HTTPS version of the old URL. if ( untrailingslashit( (string) $old_url ) !== str_replace( 'https://', 'http://', untrailingslashit( (string) $new_url ) ) ) { delete_option( 'https_migration_required' ); return; } // If this is a fresh site, there is no content to migrate, so do not require migration. $https_migration_required = get_option( 'fresh_site' ) ? false : true; update_option( 'https_migration_required', $https_migration_required );}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 7.1.0 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.