Theme_Upgrader::check_package( string $source ): string|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

$sourcestring

The path to the downloaded package source.

Return value

string|WP_Error

The source as passed, or a WP_Error object on failure.

Performance profile

How much work a call to Theme_Upgrader::check_package() 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

Heavy

Reads or writes the filesystem via is_dir().

Scaling

Constant

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

Instructions

12–89

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• filesystemfilesystem accessis_dir()called directly
• hookthird-party callbacksdo_action()one call below Theme_Upgrader::check_package()

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 · 17 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost Theme_Upgrader::check_package() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• wp_get_wp_version()Returns the current WordPress version.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• trailingslashit()Appends a trailing slash.
• __()Retrieves the translation of $text.
• get_file_data()Retrieves metadata from a file.
• is_php_version_compatible()Checks compatibility with the current PHP version.
• is_wp_version_compatible()Checks compatibility with the current WordPress version.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

562	public function check_package( $source ) {563		global $wp_filesystem;564 565		$wp_version           = wp_get_wp_version();566		$this->new_theme_data = array();567 568		if ( is_wp_error( $source ) ) {569			return $source;570		}571 572		// Check that the folder contains a valid theme.573		$working_directory = str_replace( $wp_filesystem->wp_content_dir(), trailingslashit( WP_CONTENT_DIR ), $source );574		if ( ! is_dir( $working_directory ) ) { // Confidence check, if the above fails, let's not prevent installation.575			return $source;576		}577 578		// A proper archive should have a style.css file in the single subdirectory.579		if ( ! file_exists( $working_directory . 'style.css' ) ) {580			return new WP_Error(581				'incompatible_archive_theme_no_style',582				$this->strings['incompatible_archive'],583				sprintf(584					/* translators: %s: style.css */585					__( 'The theme is missing the %s stylesheet.' ),586					'<code>style.css</code>'587				)588			);589		}590 591		// All these headers are needed on Theme_Installer_Skin::do_overwrite().592		$info = get_file_data(593			$working_directory . 'style.css',594			array(595				'Name'        => 'Theme Name',596				'Version'     => 'Version',597				'Author'      => 'Author',598				'Template'    => 'Template',599				'RequiresWP'  => 'Requires at least',600				'RequiresPHP' => 'Requires PHP',601			)602		);603 604		if ( empty( $info['Name'] ) ) {605			return new WP_Error(606				'incompatible_archive_theme_no_name',607				$this->strings['incompatible_archive'],608				sprintf(609					/* translators: %s: style.css */610					__( 'The %s stylesheet does not contain a valid theme header.' ),611					'<code>style.css</code>'612				)613			);614		}615 616		/*617		 * Parent themes must contain an index file:618		 * - classic themes require /index.php619		 * - block themes require /templates/index.html or block-templates/index.html (deprecated 5.9.0).620		 */621		if (622			empty( $info['Template'] ) &&623			! file_exists( $working_directory . 'index.php' ) &&624			! file_exists( $working_directory . 'templates/index.html' ) &&625			! file_exists( $working_directory . 'block-templates/index.html' )626		) {627			return new WP_Error(628				'incompatible_archive_theme_no_index',629				$this->strings['incompatible_archive'],630				sprintf(631					/* translators: 1: templates/index.html, 2: index.php, 3: Documentation URL, 4: Template, 5: style.css */632					__( 'Template is missing. Standalone themes need to have a %1$s or %2$s template file. <a href="%3$s">Child themes</a> need to have a %4$s header in the %5$s stylesheet.' ),633					'<code>templates/index.html</code>',634					'<code>index.php</code>',635					__( 'https://developer.wordpress.org/themes/advanced-topics/child-themes/' ),636					'<code>Template</code>',637					'<code>style.css</code>'638				)639			);640		}641

Changelog

Introduced in 3.3.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 6.7.7 tag, from src/wp-admin/includes/class-theme-upgrader.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.