Theme_Upgrader::upgrade( string $theme, array $args = array() )
Upgrade a theme.
Parameters
- $theme
-
(Required) The theme slug.
- $args
-
(Optional) Other arguments for upgrading a theme. <br>
- 'clear_update_cache'
(bool) Whether to clear the update cache if successful.<br> Default true.<br>
Default value: array()
- 'clear_update_cache'
Return
(bool|WP_Error) True if the upgrade was successful, false or a WP_Error object otherwise.
Source
File: wp-admin/includes/class-theme-upgrader.php
public function upgrade( $theme, $args = array() ) {
$defaults = array(
'clear_update_cache' => true,
);
$parsed_args = wp_parse_args( $args, $defaults );
$this->init();
$this->upgrade_strings();
// Is an update available?
$current = get_site_transient( 'update_themes' );
if ( !isset( $current->response[ $theme ] ) ) {
$this->skin->before();
$this->skin->set_result(false);
$this->skin->error( 'up_to_date' );
$this->skin->after();
return false;
}
$r = $current->response[ $theme ];
add_filter('upgrader_pre_install', array($this, 'current_before'), 10, 2);
add_filter('upgrader_post_install', array($this, 'current_after'), 10, 2);
add_filter('upgrader_clear_destination', array($this, 'delete_old_theme'), 10, 4);
if ( $parsed_args['clear_update_cache'] ) {
// Clear cache so wp_update_themes() knows about the new theme.
add_action( 'upgrader_process_complete', 'wp_clean_themes_cache', 9, 0 );
}
$this->run( array(
'package' => $r['package'],
'destination' => get_theme_root( $theme ),
'clear_destination' => true,
'clear_working' => true,
'hook_extra' => array(
'theme' => $theme,
'type' => 'theme',
'action' => 'update',
),
) );
remove_action( 'upgrader_process_complete', 'wp_clean_themes_cache', 9 );
remove_filter('upgrader_pre_install', array($this, 'current_before'));
remove_filter('upgrader_post_install', array($this, 'current_after'));
remove_filter('upgrader_clear_destination', array($this, 'delete_old_theme'));
if ( ! $this->result || is_wp_error($this->result) )
return $this->result;
wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
return true;
}
Changelog
Version | Description |
---|---|
3.7.0 | The $args parameter was added, making clearing the update cache optional. |
2.8.0 | Introduced. |