Theme_Upgrader::install

Advertisement

Summery Summery

Install a theme package.

Syntax Syntax

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

Parameters Parameters

$package

(Required) The full local path or URI of the package.

$args

(Optional) Other arguments for installing a theme package.

  • 'clear_update_cache'
    (bool) Whether to clear the updates cache if successful. Default true.

Default value: array()

Return Return

(bool|WP_Error) True if the installation was successful, false or a WP_Error object otherwise.

Source Source

File: wp-admin/includes/class-theme-upgrader.php

	 * a child theme and installing the parent theme fails.
	 *
	 * @since 3.4.0
	 *
	 * @param array $actions Preview actions.
	 * @return array
	 */
	public function hide_activate_preview_actions( $actions ) {
		unset( $actions['activate'], $actions['preview'] );
		return $actions;
	}

	/**
	 * Install a theme package.
	 *
	 * @since 2.8.0
	 * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
	 *
	 * @param string $package The full local path or URI of the package.
	 * @param array  $args {
	 *     Optional. Other arguments for installing a theme package. Default empty array.
	 *
	 *     @type bool $clear_update_cache Whether to clear the updates cache if successful.
	 *                                    Default true.
	 * }
	 *
	 * @return bool|WP_Error True if the installation was successful, false or a WP_Error object otherwise.
	 */
	public function install( $package, $args = array() ) {
		$defaults    = array(
			'clear_update_cache' => true,
			'overwrite_package'  => false, // Do not overwrite files.
		);
		$parsed_args = wp_parse_args( $args, $defaults );

		$this->init();
		$this->install_strings();

		add_filter( 'upgrader_source_selection', array( $this, 'check_package' ) );
		add_filter( 'upgrader_post_install', array( $this, 'check_parent_theme_filter' ), 10, 3 );

		if ( $parsed_args['clear_update_cache'] ) {
			// Clear cache so wp_update_themes() knows about the new theme.

Advertisement

Changelog Changelog

Changelog
Version Description
3.7.0 The $args parameter was added, making clearing the update cache optional.
2.8.0 Introduced.

Advertisement

Leave a Reply