is_wp_version_compatible( string $required ): bool
- Since
- 5.2.0
- Source
wp-includes/functions.php:9005
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.
Parameters
$requiredstring- Minimum required WordPress version.
Return value
bool- True if required version is compatible or empty, false if not.
Performance profile
How much work a call to is_wp_version_compatible() 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–42
- Plugin surface
- None
- Called by
- 16
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 44.
Nothing here hands control to plugin code.
16 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 12 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost is_wp_version_compatible() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_string($required) && empty($required) | 17–21 | wp_get_wp_version(), explode() |
defined('WP_RUN_CORE_TESTS') && isset($value) && !is_string($required) && empty($required) | 20 | explode() |
!is_string($required) && !empty($required) | 23–27 | wp_get_wp_version(), explode(), version_compare() |
is_string($required) && empty($required) | 24–28 | wp_get_wp_version(), explode(), substr_count() |
defined('WP_RUN_CORE_TESTS') && isset($value) && !is_string($required) && !empty($required) | 26 | explode(), version_compare() |
defined('WP_RUN_CORE_TESTS') && isset($value) && is_string($required) && empty($required) | 27 | explode(), substr_count() |
is_string($required) && empty($required) | 29–36 | wp_get_wp_version(), explode(), substr_count(), str_ends_with() |
is_string($required) && !empty($required) | 30–34 | wp_get_wp_version(), explode(), substr_count(), version_compare() |
defined('WP_RUN_CORE_TESTS') && isset($value) && is_string($required) && empty($required) | 32–35 | explode(), substr_count(), str_ends_with() |
defined('WP_RUN_CORE_TESTS') && isset($value) && is_string($required) && !empty($required) | 33 | explode(), substr_count(), version_compare() |
is_string($required) && !empty($required) | 35–42 | wp_get_wp_version(), explode(), substr_count(), str_ends_with(), version_compare() |
defined('WP_RUN_CORE_TESTS') && isset($value) && is_string($required) && !empty($required) | 38–41 | explode(), substr_count(), str_ends_with(), version_compare() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 44 | 17–42 | 7 | |
| 8.5 | 44 | 17–42 | 7 | |
| 8.4 | 44 | 17–42 | 7 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 50 | 17–48 | 7 | |
| 8.2 | 50 | 17–48 | 7 | |
| 8.1 | 50 | 17–48 | 7 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 52 | 17–49 | 7 |
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 · 2
- wp_get_wp_version()Returns the current WordPress version.
- str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
Used by · 16
- Plugin_Installer_Skin::do_overwrite()Checks if the plugin can be overwritten and outputs the HTML for overwriting a plugin on upload.
- Plugin_Upgrader::bulk_upgrade()Upgrades several plugins at once.
- Plugin_Upgrader::check_package()Checks that the source package contains a valid plugin.
- Theme_Installer_Skin::do_overwrite()Checks if the theme can be overwritten and outputs the HTML for overwriting a theme on upload.
- Theme_Upgrader::bulk_upgrade()Upgrades several themes at once.
- Theme_Upgrader::check_package()Checks that the package source contains a valid theme.
- WP_Customize_Manager::handle_load_themes_request()Loads themes into the theme browsing/installation UI.
- WP_Plugin_Install_List_Table::display_rows()Generates the list table rows.
- WP_Plugins_List_Table::single_row()
- install_plugin_information()Displays plugin information in dialog box form.
- list_theme_updates()Display the upgrade themes form.
- validate_plugin_requirements()Validates the plugin requirements for WordPress version and PHP version.
Show all 16
- validate_theme_requirements()Validates the theme requirements for WordPress version and PHP version.
- wp_ajax_query_themes()Handles getting themes from themes_api() via AJAX.
- wp_prepare_themes_for_js()Prepares themes for JavaScript.
- wp_theme_update_row()Displays update information for a theme.
Source code
function is_wp_version_compatible( $required ) { if ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS && isset( $GLOBALS['_wp_tests_wp_version'] ) ) { $wp_version = $GLOBALS['_wp_tests_wp_version']; } else { $wp_version = wp_get_wp_version(); } // Strip off any -alpha, -RC, -beta, -src suffixes. list( $version ) = explode( '-', $wp_version ); if ( is_string( $required ) ) { $trimmed = trim( $required ); if ( substr_count( $trimmed, '.' ) > 1 && str_ends_with( $trimmed, '.0' ) ) { $required = substr( $trimmed, 0, -2 ); } } return empty( $required ) || version_compare( $version, $required, '>=' );}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 7.0.4 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.