validate_theme_requirements( string $stylesheet ): true|WP_Error

Description

Compatibility

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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

39–57

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 98.

Plugin surface

1 hook

Third-party callbacks on 'validate_theme_requirements' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

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.

Hooks and filters fired · 1

One hook fires while validate_theme_requirements() runs, in this order:

1. 1
   apply_filters( validate_theme_requirements )filterline 1015 (+53 into the body)

   Filters the theme requirement validation response.

Uses · 6

• 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.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Error::__construct()Initializes the error.

Used by · 1

• switch_theme()Switches the theme.

Source code

View on Trac ↗View on GitHub ↗

962function validate_theme_requirements( $stylesheet ) {963	$theme = wp_get_theme( $stylesheet );964 965	$requirements = array(966		'requires'     => ! empty( $theme->get( 'RequiresWP' ) ) ? $theme->get( 'RequiresWP' ) : '',967		'requires_php' => ! empty( $theme->get( 'RequiresPHP' ) ) ? $theme->get( 'RequiresPHP' ) : '',968	);969 970	$compatible_wp  = is_wp_version_compatible( $requirements['requires'] );971	$compatible_php = is_php_version_compatible( $requirements['requires_php'] );972 973	if ( ! $compatible_wp && ! $compatible_php ) {974		return new WP_Error(975			'theme_wp_php_incompatible',976			sprintf(977				/* translators: %s: Theme name. */978				_x( '<strong>Error:</strong> Current WordPress and PHP versions do not meet minimum requirements for %s.', 'theme' ),979				$theme->display( 'Name' )980			)981		);982	} elseif ( ! $compatible_php ) {983		return new WP_Error(984			'theme_php_incompatible',985			sprintf(986				/* translators: %s: Theme name. */987				_x( '<strong>Error:</strong> Current PHP version does not meet minimum requirements for %s.', 'theme' ),988				$theme->display( 'Name' )989			)990		);991	} elseif ( ! $compatible_wp ) {992		return new WP_Error(993			'theme_wp_incompatible',994			sprintf(995				/* translators: %s: Theme name. */996				_x( '<strong>Error:</strong> Current WordPress version does not meet minimum requirements for %s.', 'theme' ),997				$theme->display( 'Name' )998			)999		);1000	}1001 1002	/**1003	 * Filters the theme requirement validation response.1004	 *1005	 * If a theme fails due to a Core-provided validation (incompatible WP, PHP versions), this1006	 * filter will not fire. A WP_Error response will already be returned.1007	 *1008	 * This filter is intended to add additional validation steps by site administrators.1009	 *1010	 * @since 6.9.01011	 *1012	 * @param bool|WP_Error $met_requirements True if the theme meets requirements, WP_Error if not.1013	 * @param string $stylesheet Directory name for the theme.1014	 */1015	return apply_filters( 'validate_theme_requirements', true, $stylesheet );1016}

Changelog

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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/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.