wp_get_update_php_annotation(): string
- Since
- 5.2.0
- Source
wp-includes/functions.php:8553
Description
This function is to be used after wp_get_update_php_url() to return a consistent annotation if the web host has altered the default "Update PHP" page URL.
Compatibility
- WordPress
- since 5.2.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- Update PHP page annotation. An empty string if no custom URLs are provided.
Performance profile
How much work a call to wp_get_update_php_annotation() 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
- 9–20
- Plugin surface
- None
- Called by
- 6
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 21.
Nothing here hands control to plugin code.
6 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()one call below wp_get_update_php_annotation()
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_annotation() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$update_url === false | 9 | wp_get_update_php_url(), wp_get_default_update_php_url() |
$update_url !== false | 20 | wp_get_update_php_url(), wp_get_default_update_php_url(), __(), esc_url(), sprintf() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 21 instructions, 9–20 executed per call, 1 branch. 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.
Uses · 4
- wp_get_update_php_url()Gets the URL to learn more about updating the PHP version the site is running on.
- wp_get_default_update_php_url()Gets the default URL to learn more about updating the PHP version the site is running on.
- __()Retrieves the translation of $text.
- esc_url()Checks and cleans a URL.
Used by · 6
- 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_update_php_annotation()Prints the default annotation for the web host altering the "Update PHP" page URL.
Source code
function wp_get_update_php_annotation() { $update_url = wp_get_update_php_url(); $default_url = wp_get_default_update_php_url(); if ( $update_url === $default_url ) { return ''; } $annotation = sprintf( /* translators: %s: Default Update PHP page URL. */ __( 'This resource is provided by your web host, and is specific to your site. For more information, <a href="%s" target="_blank">see the official WordPress documentation</a>.' ), esc_url( $default_url ) ); return $annotation;}Changelog
Introduced in 5.2.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.9.7 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.