Theme_Upgrader::check_package( string $source ): string|WP_Error
- Since
- 3.3.0
- Source
wp-admin/includes/class-theme-upgrader.php:562
Checks that the package source contains a valid theme.
Description
Hooked to the 'upgrader_source_selection' filter by Theme_Upgrader::install().
Compatibility
- WordPress
- since 3.3.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
$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
- Scaling
- Constant
- Instructions
- 12–89
- Plugin surface
- None
- Called by
- 0
Reads or writes the filesystem via is_dir().
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 169.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- filesystemfilesystem access
is_dir()called directly - hookthird-party callbacks
do_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.
| When | Instructions | Calls it makes |
|---|---|---|
is_wp_error() | 12 | wp_get_wp_version(), is_wp_error() |
!is_wp_error() && !is_dir() | 24 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir() |
!is_wp_error() && is_dir() && !file_exists() | 44 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), __(), sprintf() |
!is_wp_error() && is_dir() && file_exists() && empty($info) | 52 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), __(), sprintf() |
!is_wp_error() && is_dir() && file_exists() && !empty($info) && is_php_version_compatible() && is_wp_version_compatible() | 57–59 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), is_php_version_compatible(), is_wp_version_compatible() |
!is_wp_error() && is_dir() && file_exists() && is_php_version_compatible() && is_wp_version_compatible() | 62–64 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), is_php_version_compatible(), is_wp_version_compatible() |
!is_wp_error() && is_dir() && is_php_version_compatible() && is_wp_version_compatible() | 67–69 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), file_exists(), is_php_version_compatible(), is_wp_version_compatible() |
!is_wp_error() && is_dir() && file_exists() && !empty($info) && !is_php_version_compatible() | 68–70 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), is_php_version_compatible(), __(), sprintf() |
!is_wp_error() && is_dir() && file_exists() && !empty($info) && is_php_version_compatible() && !is_wp_version_compatible() | 72–74 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), is_php_version_compatible(), is_wp_version_compatible(), __(), sprintf() |
!is_wp_error() && is_dir() && is_php_version_compatible() && is_wp_version_compatible() | 72–74 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), file_exists(), file_exists(), is_php_version_compatible(), is_wp_version_compatible() |
!is_wp_error() && is_dir() && file_exists() && !is_php_version_compatible() | 73–75 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), is_php_version_compatible(), __(), sprintf() |
!is_wp_error() && is_dir() | 76 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), file_exists(), file_exists(), __(), __(), sprintf() |
5 further outcomes, up to 89 instructions
!is_wp_error() && is_dir() && file_exists() && is_php_version_compatible() && !is_wp_version_compatible() | 77–79 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), is_php_version_compatible(), is_wp_version_compatible(), __(), sprintf() |
!is_wp_error() && is_dir() && !is_php_version_compatible() | 78–80 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), file_exists(), is_php_version_compatible(), __(), sprintf() |
!is_wp_error() && is_dir() && is_php_version_compatible() && !is_wp_version_compatible() | 82–84 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), file_exists(), is_php_version_compatible(), is_wp_version_compatible(), __(), sprintf() |
!is_wp_error() && is_dir() && !is_php_version_compatible() | 83–85 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), file_exists(), file_exists(), is_php_version_compatible(), __(), sprintf() |
!is_wp_error() && is_dir() && is_php_version_compatible() && !is_wp_version_compatible() | 87–89 | wp_get_wp_version(), is_wp_error(), ->wp_content_dir(), trailingslashit(), is_dir(), file_exists(), get_file_data(), file_exists(), file_exists(), file_exists(), is_php_version_compatible(), is_wp_version_compatible(), __(), sprintf() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 169 | 12–89 | 12 | |
| 8.5 | 169 | 12–89 | 12 | |
| 8.4 | 169 | 12–89 | 12 | 4 fewer instructions than PHP 8.3 |
| 8.3 | 173 | 12–93 | 12 | |
| 8.2 | 173 | 12–93 | 12 | |
| 8.1 | 173 | 12–93 | 12 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 175 | 12–95 | 12 |
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 · 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
public function check_package( $source ) { global $wp_filesystem; $wp_version = wp_get_wp_version(); $this->new_theme_data = array(); if ( is_wp_error( $source ) ) { return $source; } // Check that the folder contains a valid theme. $working_directory = str_replace( $wp_filesystem->wp_content_dir(), trailingslashit( WP_CONTENT_DIR ), $source ); if ( ! is_dir( $working_directory ) ) { // Confidence check, if the above fails, let's not prevent installation. return $source; } // A proper archive should have a style.css file in the single subdirectory. if ( ! file_exists( $working_directory . 'style.css' ) ) { return new WP_Error( 'incompatible_archive_theme_no_style', $this->strings['incompatible_archive'], sprintf( /* translators: %s: style.css */ __( 'The theme is missing the %s stylesheet.' ), '<code>style.css</code>' ) ); } // All these headers are needed on Theme_Installer_Skin::do_overwrite(). $info = get_file_data( $working_directory . 'style.css', array( 'Name' => 'Theme Name', 'Version' => 'Version', 'Author' => 'Author', 'Template' => 'Template', 'RequiresWP' => 'Requires at least', 'RequiresPHP' => 'Requires PHP', ) ); if ( empty( $info['Name'] ) ) { return new WP_Error( 'incompatible_archive_theme_no_name', $this->strings['incompatible_archive'], sprintf( /* translators: %s: style.css */ __( 'The %s stylesheet does not contain a valid theme header.' ), '<code>style.css</code>' ) ); } /* * Parent themes must contain an index file: * - classic themes require /index.php * - block themes require /templates/index.html or block-templates/index.html (deprecated 5.9.0). */ if ( empty( $info['Template'] ) && ! file_exists( $working_directory . 'index.php' ) && ! file_exists( $working_directory . 'templates/index.html' ) && ! file_exists( $working_directory . 'block-templates/index.html' ) ) { return new WP_Error( 'incompatible_archive_theme_no_index', $this->strings['incompatible_archive'], sprintf( /* translators: 1: templates/index.html, 2: index.php, 3: Documentation URL, 4: Template, 5: style.css */ __( '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.' ), '<code>templates/index.html</code>', '<code>index.php</code>', __( 'https://developer.wordpress.org/themes/advanced-topics/child-themes/' ), '<code>Template</code>', '<code>style.css</code>' ) ); }Changelog
Introduced in 3.3.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 6.8.8 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.