Theme_Installer_Skin::do_overwrite(): bool

Compatibility

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

Return value

bool

Whether the theme can be overwritten and HTML was outputted.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

4–281

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

Plugin surface

2 hooks

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

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

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

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 2

2 hooks fire while Theme_Installer_Skin::do_overwrite() runs, in this order:

1. 1
   apply_filters( install_theme_overwrite_comparison )filterline 295 (+92 into the body)

   Filters the compare table output for overwriting a theme package on upload.

2. 2
   apply_filters( install_theme_overwrite_actions )filterline 378 (+175 into the body)

   Filters the list of action links available following a single theme installation failure when overwriting is allowed.

Uses · 16

• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_get_themes()Returns an array of WP_Theme objects based on the arguments.
• wp_normalize_path()Normalizes a filesystem path.
• esc_html__()Retrieves the translation of $text and escapes it for safe use in HTML output.
• __()Retrieves the translation of $text.
• esc_html_x()Translates string with gettext context, and escapes it for safe use in HTML output.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_php_version_compatible()Checks compatibility with the current PHP version.
• esc_html()Escaping for HTML blocks.
• is_wp_version_compatible()Checks compatibility with the current WordPress version.
• wp_get_wp_version()Returns the current WordPress version.

Used by · 1

• Theme_Installer_Skin::after()Performs an action following a single theme install.

Source code

View on Trac ↗View on GitHub ↗

203	private function do_overwrite() {204		if ( 'upload' !== $this->type || ! is_wp_error( $this->result ) || 'folder_exists' !== $this->result->get_error_code() ) {205			return false;206		}207 208		$folder = $this->result->get_error_data( 'folder_exists' );209		$folder = rtrim( $folder, '/' );210 211		$current_theme_data = false;212		$all_themes         = wp_get_themes( array( 'errors' => null ) );213 214		foreach ( $all_themes as $theme ) {215			$stylesheet_dir = wp_normalize_path( $theme->get_stylesheet_directory() );216 217			if ( rtrim( $stylesheet_dir, '/' ) !== $folder ) {218				continue;219			}220 221			$current_theme_data = $theme;222		}223 224		$new_theme_data = $this->upgrader->new_theme_data;225 226		if ( ! $current_theme_data || ! $new_theme_data ) {227			return false;228		}229 230		echo '<h2 class="update-from-upload-heading">' . esc_html__( 'This theme is already installed.' ) . '</h2>';231 232		// Check errors for active theme.233		if ( is_wp_error( $current_theme_data->errors() ) ) {234			$this->feedback( 'current_theme_has_errors', $current_theme_data->errors()->get_error_message() );235		}236 237		$this->is_downgrading = version_compare( $current_theme_data['Version'], $new_theme_data['Version'], '>' );238 239		$is_invalid_parent = false;240		if ( ! empty( $new_theme_data['Template'] ) ) {241			$is_invalid_parent = ! in_array( $new_theme_data['Template'], array_keys( $all_themes ), true );242		}243 244		$rows = array(245			'Name'        => __( 'Theme name' ),246			'Version'     => __( 'Version' ),247			'Author'      => __( 'Author' ),248			'RequiresWP'  => __( 'Required WordPress version' ),249			'RequiresPHP' => __( 'Required PHP version' ),250			'Template'    => __( 'Parent theme' ),251		);252 253		$table  = '<table class="update-from-upload-comparison"><tbody>';254		$table .= '<tr><th></th><th>' . esc_html_x( 'Active', 'theme' ) . '</th><th>' . esc_html_x( 'Uploaded', 'theme' ) . '</th></tr>';255 256		$is_same_theme = true; // Let's consider only these rows.257 258		foreach ( $rows as $field => $label ) {259			$old_value = $current_theme_data->display( $field, false );260			$old_value = $old_value ? (string) $old_value : '-';261 262			$new_value = ! empty( $new_theme_data[ $field ] ) ? (string) $new_theme_data[ $field ] : '-';263 264			if ( $old_value === $new_value && '-' === $new_value && 'Template' === $field ) {265				continue;266			}267 268			$is_same_theme = $is_same_theme && ( $old_value === $new_value );269 270			$diff_field     = ( 'Version' !== $field && $new_value !== $old_value );271			$diff_version   = ( 'Version' === $field && $this->is_downgrading );272			$invalid_parent = false;273 274			if ( 'Template' === $field && $is_invalid_parent ) {275				$invalid_parent = true;276				$new_value     .= ' ' . __( '(not found)' );277			}278 279			$table .= '<tr><td class="name-label">' . $label . '</td><td>' . wp_strip_all_tags( $old_value ) . '</td>';280			$table .= ( $diff_field || $diff_version || $invalid_parent ) ? '<td class="warning">' : '<td>';281			$table .= wp_strip_all_tags( $new_value ) . '</td></tr>';282		}

Changelog

Introduced in 5.5.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.10 tag, from src/wp-admin/includes/class-theme-installer-skin.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.