Theme_Upgrader::install( string $package, array $args = array() ): bool|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$packagestring

The full local path or URI of the package.

$argsarrayoptional

Other arguments for installing a theme package. Default empty array.Default: array()

• $clear_update_cachebooldefault: true

  Whether to clear the updates cache if successful.

Return value

bool|WP_Error

True if the installation was successful, false or a WP_Error object otherwise.

Performance profile

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

64–90

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

Plugin surface

1 hook

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

Called by

0

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

What it touches

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach option, cache, transient, serialize 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 · 8 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   do_action( upgrader_overwrote_package )actionline 274 (+44 into the body)

   Fires when the upgrader has successfully overwritten a currently installed plugin or theme with an uploaded zip package.

Uses · 12

• wp_parse_args()Merges user defined arguments into defaults array.
• add_filter()Adds a callback function to a filter hook.
• add_action()Adds a callback function to an action hook.
• get_theme_root()Retrieves path to themes directory.
• remove_action()Removes a callback function from an action hook.
• remove_filter()Removes a callback function from a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_clean_themes_cache()Clears the cache held by get_theme_roots() and WP_Theme.
• do_action()Calls the callback functions that have been added to an action hook.
• Theme_Upgrader::init()
• Theme_Upgrader::install_strings()Initializes the installation strings.
• Theme_Upgrader::run()

Source code

View on Trac ↗View on GitHub ↗

230	public function install( $package, $args = array() ) {231		$defaults    = array(232			'clear_update_cache' => true,233			'overwrite_package'  => false, // Do not overwrite files.234		);235		$parsed_args = wp_parse_args( $args, $defaults );236 237		$this->init();238		$this->install_strings();239 240		add_filter( 'upgrader_source_selection', array( $this, 'check_package' ) );241		add_filter( 'upgrader_post_install', array( $this, 'check_parent_theme_filter' ), 10, 3 );242 243		if ( $parsed_args['clear_update_cache'] ) {244			// Clear cache so wp_update_themes() knows about the new theme.245			add_action( 'upgrader_process_complete', 'wp_clean_themes_cache', 9, 0 );246		}247 248		$this->run(249			array(250				'package'           => $package,251				'destination'       => get_theme_root(),252				'clear_destination' => $parsed_args['overwrite_package'],253				'clear_working'     => true,254				'hook_extra'        => array(255					'type'   => 'theme',256					'action' => 'install',257				),258			)259		);260 261		remove_action( 'upgrader_process_complete', 'wp_clean_themes_cache', 9 );262		remove_filter( 'upgrader_source_selection', array( $this, 'check_package' ) );263		remove_filter( 'upgrader_post_install', array( $this, 'check_parent_theme_filter' ) );264 265		if ( ! $this->result || is_wp_error( $this->result ) ) {266			return $this->result;267		}268 269		// Refresh the Theme Update information.270		wp_clean_themes_cache( $parsed_args['clear_update_cache'] );271 272		if ( $parsed_args['overwrite_package'] ) {273			/** This action is documented in wp-admin/includes/class-plugin-upgrader.php */274			do_action( 'upgrader_overwrote_package', $package, $this->new_theme_data, 'theme' );275		}276 277		return true;278	}

Changelog

Introduced in 2.8.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-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.