validate_theme_requirements( string $stylesheet ): true|WP_Error
- Since
- 5.5.0, 5.8.0
- Source
wp-includes/theme.php:965
Description
Uses the information from Requires at least and Requires PHP headers defined in the theme's style.css file.
Compatibility
- WordPress
- since 5.8.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
$stylesheetstring- Directory name for the theme.
Return value
true|WP_Error- True if requirements are met, WP_Error on failure.
Performance profile
How much work a call to validate_theme_requirements() 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
- 34–57
- Plugin surface
- None
- Called by
- 1
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 93.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 9 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost validate_theme_requirements() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!->get() | 34 | wp_get_theme(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible() |
| always | 38 | wp_get_theme(), ->get(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible() |
->get() | 42 | wp_get_theme(), ->get(), ->get(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible() |
!->get() | 48–49 | wp_get_theme(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible(), _x(), ->display(), sprintf() |
!->get() | 48 | wp_get_theme(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible(), _x(), ->display(), sprintf(), requires() |
| always | 52–53 | wp_get_theme(), ->get(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible(), _x(), ->display(), sprintf() |
| always | 52 | wp_get_theme(), ->get(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible(), _x(), ->display(), sprintf(), requires() |
->get() | 56–57 | wp_get_theme(), ->get(), ->get(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible(), _x(), ->display(), sprintf() |
->get() | 56 | wp_get_theme(), ->get(), ->get(), ->get(), ->get(), is_wp_version_compatible(), is_php_version_compatible(), _x(), ->display(), sprintf(), requires() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 91 | 34–55 | 6 | 2 fewer instructions than PHP 8.5 |
| 8.5 | 93 | 34–57 | 6 | |
| 8.4 | 93 | 34–57 | 6 | |
| 8.3 | 93 | 34–57 | 6 | |
| 8.2 | 93 | 34–57 | 6 | |
| 8.1 | 93 | 34–57 | 6 | |
| 7.4 | 93 | 34–57 | 6 |
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_get_theme()Gets a WP_Theme object for a theme.
- is_wp_version_compatible()Checks compatibility with the current WordPress version.
- is_php_version_compatible()Checks compatibility with the current PHP version.
- _x()Retrieves translated string with gettext context.
- WP_Error::__construct()Initializes the error.
Used by · 1
- switch_theme()Switches the theme.
Source code
function validate_theme_requirements( $stylesheet ) { $theme = wp_get_theme( $stylesheet ); $requirements = array( 'requires' => ! empty( $theme->get( 'RequiresWP' ) ) ? $theme->get( 'RequiresWP' ) : '', 'requires_php' => ! empty( $theme->get( 'RequiresPHP' ) ) ? $theme->get( 'RequiresPHP' ) : '', ); $compatible_wp = is_wp_version_compatible( $requirements['requires'] ); $compatible_php = is_php_version_compatible( $requirements['requires_php'] ); if ( ! $compatible_wp && ! $compatible_php ) { return new WP_Error( 'theme_wp_php_incompatible', sprintf( /* translators: %s: Theme name. */ _x( '<strong>Error:</strong> Current WordPress and PHP versions do not meet minimum requirements for %s.', 'theme' ), $theme->display( 'Name' ) ) ); } elseif ( ! $compatible_php ) { return new WP_Error( 'theme_php_incompatible', sprintf( /* translators: %s: Theme name. */ _x( '<strong>Error:</strong> Current PHP version does not meet minimum requirements for %s.', 'theme' ), $theme->display( 'Name' ) ) ); } elseif ( ! $compatible_wp ) { return new WP_Error( 'theme_wp_incompatible', sprintf( /* translators: %s: Theme name. */ _x( '<strong>Error:</strong> Current WordPress version does not meet minimum requirements for %s.', 'theme' ), $theme->display( 'Name' ) ) ); } return true;}Changelog
Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
readme.txt as a fallback.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/theme.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.