wp_get_update_php_url(): string
- Since
- 5.1.0
- Source
wp-includes/functions.php:8646
Description
This URL can be overridden by specifying an environment variable WP_UPDATE_PHP_URL or by using the 'wp_update_php_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.
Compatibility
- WordPress
- since 5.1.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
string- URL to learn more about updating PHP.
Performance profile
How much work a call to wp_get_update_php_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
- Trivial
- Scaling
- Constant
- Instructions
- 17–22
- Plugin surface
- 1 hook
- Called by
- 15
Touches nothing outside its own arguments.
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 22.
Third-party callbacks on 'wp_update_php_url' run inside this call, and their cost is not bounded by anything here.
15 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach query, option, cache, serialize 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_update_php_url() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 17–18 | wp_get_default_update_php_url(), getenv(), apply_filters() |
| always | 21–22 | wp_get_default_update_php_url(), getenv(), getenv(), 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: 22 instructions, 17–22 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_get_update_php_url() runs, in this order:
- apply_filters( wp_update_php_url )filterline 8664 (+18 into the body)
Filters the URL to learn more about updating the PHP version the site is running on.
Uses · 2
- wp_get_default_update_php_url()Gets the default URL to learn more about updating the PHP version the site is running on.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 15
- WP_Customize_Theme_Control::content_template()Render a JS template for theme display.
- WP_Plugin_Install_List_Table::display_rows()Generates the list table rows.
- WP_Plugins_List_Table::single_row()Generates the markup for a single plugin row.
- WP_Site_Health::get_test_php_version()Tests if the supplied PHP version is supported.
- customize_themes_print_templates()Prints JS templates for the theme-browsing UI in the Customizer.
- install_plugin_information()Displays plugin information in dialog box form.
- list_core_update()Lists available core updates.
- list_plugin_updates()Display the upgrade plugins form.
- list_theme_updates()Display the upgrade themes form.
- update_core()Upgrades the core of WordPress.
- validate_plugin_requirements()Validates the plugin requirements for WordPress version and PHP version.
- wp_dashboard_php_nag()Displays the PHP update nag.
Show all 15
- wp_get_update_php_annotation()Returns the default annotation for the web hosting altering the "Update PHP" page URL.
- wp_plugin_update_row()Displays update information for a plugin.
- wp_theme_update_row()Displays update information for a theme.
Source code
function wp_get_update_php_url() { $default_url = wp_get_default_update_php_url(); $update_url = $default_url; if ( false !== getenv( 'WP_UPDATE_PHP_URL' ) ) { $update_url = getenv( 'WP_UPDATE_PHP_URL' ); } /** * Filters the URL to learn more about updating the PHP 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.1.0 * * @param string $update_url URL to learn more about updating PHP. */ $update_url = apply_filters( 'wp_update_php_url', $update_url ); if ( empty( $update_url ) ) { $update_url = $default_url; } return $update_url;}Changelog
Introduced in 5.1.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/functions.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.