wp_update_php_annotation( string $before = '<p class="description">', string $after = '</p>', bool $display = true ): string|void
- Since
- 5.1.0, 5.2.0, 6.4.0
- Source
wp-includes/functions.php:8479
Description
This function is to be used after wp_get_update_php_url() to display a consistent annotation if the web host has altered the default "Update PHP" page URL.
Compatibility
- WordPress
- since 6.4.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
$beforestringoptional- Markup to output before the annotation. Default
<p class="description">.Default:'<p class="description">' $afterstringoptional- Markup to output after the annotation. Default
</p>.Default:'</p>' $displaybooloptional- Whether to echo or return the markup. Default
truefor echo.Default:true
Return value
string|void
Performance profile
How much work a call to wp_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
- 8–12
- Plugin surface
- None
- Called by
- 8
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 16.
Nothing here hands control to plugin code.
8 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_update_php_annotation() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 8–12 | wp_get_update_php_annotation() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 16 instructions, 8–12 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.
Uses · 1
- wp_get_update_php_annotation()Returns the default annotation for the web hosting altering the "Update PHP" page URL.
Used by · 8
- 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()
- 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.
- wp_dashboard_php_nag()Displays the PHP update nag.
- wp_plugin_update_row()Displays update information for a plugin.
- wp_theme_update_row()Displays update information for a theme.
Source code
function wp_update_php_annotation( $before = '<p class="description">', $after = '</p>', $display = true ) { $annotation = wp_get_update_php_annotation(); if ( $annotation ) { if ( $display ) { echo $before . $annotation . $after; } else { return $before . $annotation . $after; } }}Changelog
Introduced in 5.1.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
string|void to string|null.verified against source$display parameter.from the docblock$before and $after parameters.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 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.